v4

latestSwagger 2.02026-08-0343714211.7 MB

sso_events

SSO Events

List SSO Events

get/sso_events

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at, event_type, status or user_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, event_type, idp_uid, ip, provider, status, user_id or username. Valid field combinations are [ event_type, created_at ], [ idp_uid, created_at ], [ ip, created_at ], [ provider, created_at ], [ status, created_at ], [ user_id, created_at ], [ username, created_at ], [ event_type, status ], [ idp_uid, status ], [ ip, status ], [ provider, status ], [ user_id, status ], [ username, status ], [ event_type, status, created_at ], [ idp_uid, status, created_at ], [ ip, status, created_at ], [ provider, status, created_at ], [ user_id, status, created_at ] or [ username, status, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is prefixed by the supplied value. Valid fields are idp_uid, ip, provider or username.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of SsoEvents objects.

idinteger

Event ID

event_type'ldap_sync' | 'ldap_login' | 'saml_login'

Type of SSO event being recorded.

status'success' | 'failure' | 'partial_failure' | 'in_progress' | 'skipped'

Status of event.

bodystring

Event body.

event_errorsstring[]

Event errors.

created_atstring date-time

Event create date/time.

body_urlstring

Link to log file.

user_idinteger

User ID.

usernamestring

Username on Files.com for the SSO login attempt.

idp_uidstring

Identity Provider UID for the SSO login attempt.

providerstring

SSO provider for the SSO login attempt.

provider_labelstring

SSO provider label for the SSO login attempt.

ipstring

IP address for the SSO login attempt.

regionstring

Region for the SSO login attempt.

Example response

[
  {
    "id": 1,
    "event_type": "example",
    "status": "example",
    "body": "example",
    "event_errors": [
      "example"
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "body_url": "example",
    "user_id": 1,
    "username": "example",
    "idp_uid": "example",
    "provider": "example",
    "provider_label": "example",
    "ip": "example",
    "region": "example"
  }
]