Skip to content

Latest commit

 

History

History
78 lines (64 loc) · 7.53 KB

File metadata and controls

78 lines (64 loc) · 7.53 KB

Audit Log for Admin API and Portal

The Admin API & Portal tab in the Audit Log page allows you to analyze and monitor changes and activities that occur on Admin API and the Authgear Portal of your project.

The data under this tab can be handy for securing your Authgear project. For example, whenever an admin on your project downloads the Admin API key, the event is registered under the Admin API & Portal tab.

Accessing Admin API & Portal Audit Through the Admin API.

Activity logs for Admin API and Portal are part of the data the auditLogs query returns.

For example, the following query will return any recent events from Admin API and Portal that have been logged:

query {
  auditLogs(first:5){
    edges{
      node{
        activityType
        clientID
        createdAt
        data
      }
    }
  }
}

Note: The above request will also include events triggered by users.

Log Events

The following is a list of the activity types that are logged:

Project Actions

Activity type Description
PROJECT_APP_SECRET_VIEWED An admin downloaded the Admin API key
PROJECT_APP_UPDATED Project configurations updated
PROJECT_BILLING_CHECKOUT_CREATED An admin attempted to subscribe to one of the billing plans
PROJECT_BILLING_SUBSCRIPTION_CANCELLED Billing subscription was canceled
PROJECT_BILLING_SUBSCRIPTION_STATUS_UPDATED Account billing status is updated
PROJECT_BILLING_SUBSCRIPTION_UPDATED Billing details updated
PROJECT_COLLABORATOR_DELETED An admin is removed
PROJECT_COLLABORATOR_INVITATION_ACCEPTED A user accepted an invitation to become an admin
PROJECT_COLLABORATOR_INVITATION_CREATED Invitation to add new admin sent
PROJECT_COLLABORATOR_INVITATION_DELETED A previously sent admin invitation was canceled
PROJECT_DOMAIN_CREATED A new custom domain name added
PROJECT_DOMAIN_DELETED A custom domain name was removed
PROJECT_DOMAIN_VERIFIED A domain name was successfully verified

User Mutations

Activity type Description
ADMIN_API_MUTATION_SET_DISABLED_STATUS_EXECUTED Admin disabled/enabled a user account
ADMIN_API_MUTATION_CREATE_SESSION_EXECUTED A new session is created
ADMIN_API_MUTATION_ANONYMIZE_USER_EXECUTED An admin initiated the process to annonymize a normal user. This command will delete all user data like email, full name and phone number
ADMIN_API_MUTATION_CREATE_IDENTITY_EXECUTED New Identity was created by an admin
ADMIN_API_MUTATION_CREATE_USER_EXECUTED An admin created a new user
ADMIN_API_MUTATION_DELETE_AUTHENTICATOR_EXECUTED An authenticator was removed
ADMIN_API_MUTATION_DELETE_AUTHORIZATION_EXECUTED An authorization was removed
ADMIN_API_MUTATION_DELETE_IDENTITY_EXECUTED Identity deleted
ADMIN_API_MUTATION_DELETE_USER_EXECUTED An admin deleted a user
ADMIN_API_MUTATION_GENERATE_OOB_OTP_CODE_EXECUTED New OTP code generated
ADMIN_API_MUTATION_RESET_PASSWORD_EXECUTED Password was reset by an admin
ADMIN_API_MUTATION_REVOKE_ALL_SESSIONS_EXECUTED All sessions revoked
ADMIN_API_MUTATION_REVOKE_SESSION_EXECUTED A users session is revoked
ADMIN_API_MUTATION_SCHEDULE_ACCOUNT_ANONYMIZATION_EXECUTED An admin scheduled the anonymization of a user account
ADMIN_API_MUTATION_SCHEDULE_ACCOUNT_DELETION_EXECUTED An admin scheduled the deletion of a user
ADMIN_API_MUTATION_SEND_RESET_PASSWORD_MESSAGE_EXECUTED Password reset message was sent
ADMIN_API_MUTATION_SET_VERIFIED_STATUS_EXECUTED Verified status for a user is updated
ADMIN_API_MUTATION_UNSCHEDULE_ACCOUNT_ANONYMIZATION_EXECUTED A previously scheduled user anonymization request was canceled
ADMIN_API_MUTATION_UNSCHEDULE_ACCOUNT_DELETION_EXECUTED A previously scheduled user deletion request was canceled
ADMIN_API_MUTATION_UPDATE_IDENTITY_EXECUTED Identity updated by admin
ADMIN_API_MUTATION_UPDATE_USER_EXECUTED An admin updated details like a user's name, gender and more