Skip to main content
Table of Contents
User Management API

Audit logs

Get activities list

Returns all the types of activities and their category that the Audit logs API supports.

GET /audit/v1/activities

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/audit/v1/activities"

No parameter required.

Response attributes 200 application/json

Response

{
    "activities": {
        "user_management": [
            "added_member",
            "removed_member",
            "changed_product_access",
            "changed_role",
            "requested_product_access",
            "exported_users",
            "created_team",
            "deleted_team",
            "changed_team",
            "sent_invitation_via_email",
            "copied_invitation_link",
            "created_new_invite_link",
            "resent_invitation"
        ],
        "user_provisioning": [
            "added_member_from_identity_provider",
            "removed_member_from_identity_provider",
            "changed_team_from_identity_provider",
            "changed_role_from_identity_provider",
            "changed_product_from_identity_provider",
            "enabled_auto_user_provisioning",
            "modified_auto_user_provisioning_configuration",
            "disabled_auto_user_provisioning"
        ],
        "user_management_using_rest_apis": [
            "added_member_using_rest_apis",
            "removed_member_using_rest_apis",
            "changed_product_access_using_rest_apis",
            "changed_role_using_rest_apis",
            "created_team_using_rest_apis",
            "deleted_team_using_rest_apis",
            "changed_team_using_rest_apis"
        ],
        "accounts": [
            "signed_in",
            "failed_to_sign_in",
            "signed_out",
            "modified_sign_in_method",
            "requested_password_recovery_link",
            "reset_password_done",
            "deleted_account",
            "changed_email_address",
            "changed_password",
            "changed_organization_name",
            "changed_ownership_of_the_account",
            "reset_access_keys",
            "exported_audit_logs",
            "failed_to_export_audit_logs",
            "updated_email_preferences"
        ],
        "settings": [
            "initiated_single_sign_on_setup",
            "enabled_single_sign_on",
            "changed_single_sign_on_configuration",
            "disabled_single_sign_on",
            "changed_invite_permission",
            "enabled_domain_restriction",
            "disabled_domain_restriction",
            "changed_invite_notification_email_permission",
            "changed_product_access_email_permission",
            "changed_sso_aup_permission",
            "changed_manage_data_access_mda_permission",
            "changed_usage_report_access_permission",
            "changed_audit_log_access_permission",
            "changed_data_access_setting"
        ]
    }
}
  • activities Object

    List of activities

    SHOW VALUES
    • user_management Array[String]

      Activities related to managing users on BrowserStack from Account

    • user_provisioning Array[String]

      Activities related to managing users from Identitiy Provider (for organizations which have Auto user provisoning enabled) from Account

    • user_management_using_rest_apis Array[String]

      Activities related to managing users using REST APIs

    • accounts Array[String]

      Activities related to managing user profile.

    • settings Array[String]

      Activities related to managing settings & permissions on BrowserStack.

Get audit events

This is the primary endpoint for retrieving the all audit events from your organization. It will return a list of activities that have occurred along with detail, such as date, actor, location, etc.

GET /audit/v1/logs

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/audit/v1/logs"

No parameter required.

Response attributes 200 application/json

Response

"log_entries": [
    {
        "event_id": "25efb0b3-b103-4078-870b-083a323d45662",
        "date": "2022-04-27T08:47:09.000Z",
        "actor": {
            "name": "Steve",
            "email": "steve.t@acme.co",
            "role": "Owner",
            "team": "Acme Inc."
        },
        "activity": {
            "category": "accounts",
            "activity_name": "reset_password_done",
            "detail": "Password changed by testappautomate830@gmail.com"
        },
        "location": "106.214.124.188"
    },
    {
        "event_id": "957d9685-3612-4ee5-r538-d28973283a355",
        "date": "2022-04-27T05:35:57.000Z",
        "actor": {
                "name": "Steve",
                "email": "steve.t@acme.com",
                "role": "Owner",
                "team": "Acme Inc."
            },
            "activity": {
                "category": "accounts",
                "activity_name": "failed_to_sign_in",
                "detail": "Failed to sign in due to Invalid Password. Authentication method: Email/Password"
            },
        "location": "106.214.124.188"
    }
]
  • log_entries Object

    List of activities

    SHOW VALUES
    • event_id String

      ID of the audit event.

    • date String

      Date of the audit event.

    • actor Object

      Details of the member who initiated the audit event.

      SHOW VALUES
      • name String

        Name of the member.

      • email String

        Email of the member.

      • role String

        Role of the member.

      • team String

        Name of the Team to which the member belongs.

    • activity Object

      Details of the activity performed.

      SHOW VALUES
      • category String

        Category of the activity.

      • activity_name String

        Name of the activity.

      • detail String

        A short description of the activity.

    • location String

      IP address from where the audit event was performed.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback