Security Events Schema
Events emitted from Stax Events follow a defined schema. For generic guidance, see Event Schemas.
Security: UserAuthenticationEvent
An event where a Stax user has authenticated to Stax.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserAuthenticationEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.auth",
"staxEventType": "Security",
"staxEventName": "UserAuthenticationEvent",
"userID": "string",
"username": "string",
"email": "user@example.com",
"role": "string",
"status": "string",
"firstName": "string",
"lastName": "string",
"message": "string",
"authMethod": "Login", "loginType": "Federated"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum | Note |
---|---|---|---|---|
→ userID | string | true | ||
→ username | string | true | ||
string | true | |||
→ role | string | true | ||
→ status | string | false | SUCCESS, FAILED | |
→ firstName | string | false | ||
→ lastName | string | false | ||
→ message | string | false | ||
→ authMethod | string | true | Login, RefreshToken | |
→ loginType | string | false | Stax, Federated | Populated when authMethod is 'Login' |
Security: APITokenAuthenticationEvent
An event where a Stax API token has authenticated to Stax.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: APITokenAuthenticationEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.auth",
"staxEventType": "Security",
"staxEventName": "APITokenAuthenticationEvent",
"userID": "string",
"role": "string",
"status": "string",
"name": "string",
"message": "string",
"authMethod": "Login"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ userID | string | true | |
→ role | string | true | |
→ status | string | false | |
→ name | string | true | |
→ message | string | false | |
→ authMethod | string | true |
Security: UserCreateEvent
An event where a new Stax user has been created.
This event does not apply to federated users which are synchronized between your identity provider (IdP) and the Stax Identity Service.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "UserCreateEvent",
"role": "string",
"userID": "string",
"email": "user@example.com",
"status": "string",
"errorCode": "string",
"firstName": "string",
"lastName": "string",
"message": "string",
"userStatus": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ role | string | false | customer_root, customer_admin, customer_user, customer_readonly, customer_costadmin |
→ userID | string | false | |
string(email) | true | ||
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | LocalUserInviteDisabled, ResourceAlreadyExists |
→ firstName | string | true | |
→ lastName | string | true | |
→ message | string | true | |
→ userStatus | string | true | INVITED |
Security: UserUpdateEvent
An event where a Stax user has been updated.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "UserUpdateEvent",
"role": "string",
"userID": "string",
"email": "user@example.com",
"status": "string",
"errorCode": "string",
"firstName": "string",
"lastName": "string",
"message": "string",
"userStatus": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ role | string | false | customer_root, customer_admin, customer_user, customer_readonly |
→ userID | string | true | |
string(email) | false | ||
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | UserNotFound, UserDisabled, ResourceAlreadyExists |
→ firstName | string | false | |
→ lastName | string | false | |
→ message | string | true | |
→ userStatus | string | true | ACTIVE,DISABLED |
Security: UserDeleteEvent
An event where a Stax user has been deleted.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserDeleteEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "UserDeleteEvent",
"userID": "string",
"email": "user@example.com",
"status": "string",
"errorCode": "string",
"firstName": "string",
"lastName": "string",
"message": "string",
"userStatus": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ userID | string | true | |
string(email) | false | ||
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | UserNotFound |
→ firstName | string | false | |
→ lastName | string | false | |
→ message | string | true | |
→ userStatus | string | true | DELETED |
Security: UserEmailVerificationEvent
An event where an email address verification email has been sent to a Stax user.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserEmailVerificationEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "UserEmailVerificationEvent",
"userID": "string",
"email": "user@example.com",
"status": "string",
"firstName": "string",
"lastName": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ userID | string | true | |
string(email) | false | ||
→ status | string | true | SUCCESS, FAILED |
→ firstName | string | false | BadRequest |
→ lastName | string | false | |
→ message | string | true |
Security: UserPasswordResetEvent
An event where a password reset email has been sent to a Stax user.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: UserPasswordResetEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "UserPasswordResetEvent",
"userID": "string",
"email": "user@example.com",
"status": "string",
"firstName": "string",
"lastName": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ userID | string | true | |
string(email) | false | ||
→ status | string | true | SUCCESS, FAILED |
→ firstName | string | false | BadRequest |
→ lastName | string | false | |
→ message | string | true |
Security: GroupCreateEvent
An event where a new Stax group has been created.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: GroupCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "GroupCreateEvent",
"groupID": "string",
"groupName": "string",
"status": "string",
"errorCode": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ groupID | string | false | |
→ groupName | string | true | |
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | ResourceAlreadyExists |
→ message | string | true |
Security: GroupUpdateEvent
An event where a Stax group has been updated.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: GroupUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "GroupUpdateEvent",
"groupID": "string",
"groupName": "string",
"status": "string",
"errorCode": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ groupID | string | true | |
→ groupName | string | false | |
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | GroupNotFound, ResourceAlreadyExists |
→ message | string | true |
Security: GroupDeleteEvent
An event where a Stax group has been deleted.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: GroupDeleteEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "GroupDeleteEvent",
"groupID": "string",
"groupName": "string",
"status": "string",
"errorCode": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ groupID | string | true | |
→ groupName | string | false | |
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | GroupNotFound |
→ message | string | true |
Security: GroupAddMemberEvent
An event where a Stax user has been added to a Stax group.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: GroupAddMemberEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "GroupAddMemberEvent",
"groupID": "string",
"groupName": "string",
"userID": "string",
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"status": "string",
"errorCode": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ groupID | string | true | |
→ groupName | string | false | |
→ userID | string | true | |
string(email) | false | ||
→ firstName | string | false | |
→ lastName | string | false | |
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | NotFound |
→ message | string | true |
Security: GroupRemoveMemberEvent
An event where a Stax user has been removed from a Stax group.
{
"version": "0",
"id": "8309d283-775a-29bc-9b9d-f6589ecc3541",
"detail-type": "Security: GroupRemoveMemberEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2019-08-24T14:15:22Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"id": "string",
"name": "string",
"alias": "string"
},
"user": {
"id": "string",
"username": "string"
},
"aws": {
"accountId": "string",
"accountName": "string",
"region": "string"
}
},
"staxEventVersion": "string",
"staxEventID": "string",
"staxEventTime": "2019-08-24T14:15:22Z",
"staxEventSource": "stax.identity",
"staxEventType": "Security",
"staxEventName": "GroupRemoveMemberEvent",
"groupID": "string",
"groupName": "string",
"userID": "string",
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"status": "string",
"errorCode": "string",
"message": "string"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ groupID | string | true | |
→ groupName | string | false | |
→ userID | string | true | |
string(email) | false | ||
→ firstName | string | false | |
→ lastName | string | false | |
→ status | string | true | SUCCESS, FAILED |
→ errorCode | string | false | NotFound |
→ message | string | true |
Security: PolicyCreateEvent
An event where a Stax policy has been created
{
"version": "0",
"id": "f081be37-5ac7-7cb0-ad04-08b73bb977a1",
"detail-type": "Security: PolicyCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T05:40:11Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"policyId": "string",
"policyName": "string",
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "PolicyCreateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "2020-10-06T05:40:11.595518Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ policyId | string | false | |
→ policyName | string | true | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | string | false | PolicyNameConflict |
→ message | string | false |
Security: PolicyUpdateEvent
An event where a Stax policy has been modified.
{
"version": "0",
"id": "e59038df-5128-77c3-69f3-a0aee3daf88c",
"detail-type": "Security: PolicyUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T05:26:32Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"policyId": "string",
"policyName": "string",
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "PolicyUpdateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "2020-10-06T05:26:32.485063Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ policyId | string | true | |
→ policyName | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | PolicyNotFound PolicyNameConflict |
→ message | any | false |
Security: PolicyDeleteEvent
An event where a Stax policy has been deleted
{
"version": "0",
"id": "074da2bb-bda2-1c87-a2aa-db123f3a3bc6",
"detail-type": "Security: PolicyDeleteEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T05:59:30Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"policyId": "string",
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "PolicyDeleteEvent",
"staxEventSource": "stax.account",
"staxEventTime": "2020-10-06T05:59:30.670672Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ policyId | string | true | |
→ policyName | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | PolicyNotFound PolicyInUse |
→ message | string | false |
Security: PolicyAttachToOrganizationEvent
An event where a Stax policy has been attached to a Stax organization
{
"version": "0",
"id": "be1b3c29-4046-8707-a8af-fb89c7f200c8",
"detail-type": "Security: PolicyAttachToOrganizationEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T06:16:11Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"organizationId": "string",
"policyId": "string",
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "PolicyAttachToOrganizationEvent",
"staxEventSource": "stax.account",
"staxEventTime": "2020-10-06T06:16:11.707693Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ policyId | string | true | |
→ organizationId | string | true | |
→ policyName | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | PolicyReserved PolicyNotAttachable PolicyNotFound PolicyAlreadyAttached MaximumPoliciesReached |
→ message | string | false |
Security: PolicyDetachFromOrganizationEvent
An event where a Stax policy has been detached from a Stax organization
{
"version": "0",
"id": "3e74347b-a9e0-6c15-d2cd-115e9b578177",
"detail-type": "Security: PolicyDetachFromOrganizationEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T06:28:38Z",
"region": "string",
"resources": [],
"detail": {
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"organizationId": "string",
"policyId": "string",
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "PolicyDetachFromOrganizationEvent",
"staxEventSource": "stax.account",
"staxEventTime": "2020-10-06T06:28:38.343113Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ policyId | string | true | |
→ organizationId | string | true | |
→ policyName | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | PolicyNotFound PolicyReserved |
→ message | string | false |
Security: ApiTokenCreateEvent
An event where a Stax API token has been created
{
"version": "0",
"id": "b2c83e1f-5ac3-3651-5f90-572c32109474",
"detail-type": "Security: ApiTokenCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T07:02:45Z",
"region": "string",
"resources": [],
"detail": {
"apiTokenName": "string",
"apiTokenRole": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "ApiTokenCreateEvent",
"staxEventSource": "stax.api",
"staxEventTime": "2020-10-06T07:02:45.787741Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ apiTokenId | string | false | |
→ apiTokenName | string | true | |
→ apiTokenRole | string | true | |
→ description | string | false | |
→ ssmKeyId | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | ApiTokenNameConflict SsmStoreFailed |
→ message | string | false |
Security: ApiTokenUpdateEvent
An event where a Stax API token has been modified.
{
"version": "0",
"id": "d365c825-63c1-95da-5fbc-9f35f6ff5513",
"detail-type": "Security: ApiTokenUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T07:04:36Z",
"region": "string",
"resources": [],
"detail": {
"apiTokenId": "string",
"apiTokenName": "string",
"apiTokenRole": "string",
"description": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "ApiTokenUpdateEvent",
"staxEventSource": "stax.api",
"staxEventTime": "2020-10-06T07:04:36.083333Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ apiTokenId | string | true | |
→ apiTokenName | string | false | |
→ apiTokenRole | string | false | |
→ description | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | ApiTokenNotFound |
→ message | string | false |
Security: ApiTokenDeleteEvent
An event where a Stax API token has been deleted.
{
"version": "0",
"id": "0851b84b-4222-e977-6461-57d399f16878",
"detail-type": "Security: ApiTokenDeleteEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-06T07:06:55Z",
"region": "string",
"resources": [],
"detail": {
"apiTokenId": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "ApiTokenDeleteEvent",
"staxEventSource": "stax.api",
"staxEventTime": "2020-10-06T07:06:55.101194Z",
"staxEventType": "Security",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
→ apiTokenId | string | true | |
→ apiTokenName | string | false | |
→ apiTokenRole | string | false | |
→ description | string | false | |
→ status | string | true | SUCCESS FAILED |
→ errorCode | any | false | ApiTokenNotFound |
→ message | string | false |