SSO Events

An SsoEvent is a log record for SSO-related activity such as LDAP syncs and SSO login attempts.

List SSO Events

Command

files-cli sso-events list

Output

Outputs a list of SsoEvent objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

files-cli sso-events list

Show SSO Event

Command

files-cli sso-events find

Output

Outputs a SsoEvent object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Sso Event ID.

Example Request

files-cli sso-events find \
  --id=1

The SsoEvent Object

Some of the commands above return a SsoEvent object. The attributes of this object are listed below.

AttributeDescription
id
int64
Event ID
event_type
string
Type of SSO event being recorded.
Possible values: ldap_sync, ldap_login, saml_login
status
string
Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string
Event body.
event_errors
array(string)
Event errors.
created_at
date-time
Event create date/time.
body_url
string
Link to log file.
user_id
int64
User ID.
username
string
Username on Files.com for the SSO login attempt.
idp_uid
string
Identity Provider UID for the SSO login attempt.
provider
string
SSO provider for the SSO login attempt.
provider_label
string
SSO provider label for the SSO login attempt.
ip
string
IP address for the SSO login attempt.
region
string
Region for the SSO login attempt.