SSO Events

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

List SSO Events

SDK Method

\Files\Model\SsoEvent::list;

Return Object

SsoEvent[]

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

try {
  $sso_events = \Files\Model\SsoEvent::list();
  foreach ($sso_events as $sso_event) {
    // Operate on $sso_event
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show SSO Event

SDK Method

\Files\Model\SsoEvent::find;

Return Object

SsoEvent

Authorization Requirement

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

Method Arguments

ArgumentDescription
id
int64
Required		Sso Event ID.

Example Request

try {
  $sso_event = \Files\Model\SsoEvent::find($id);
  // Operate on $sso_event
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The SsoEvent Object

Some of the methods 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.