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

sso_event.List()

Return Values

Returns a *sso_event.Iter and an error. Range over All() to receive files_sdk.SsoEvent values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    sso_event "github.com/Files-com/files-sdk-go/v3/ssoevent"
)

ssoEventIterator, err := sso_event.List(files_sdk.SsoEventListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for ssoEvent, err := range ssoEventIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(ssoEvent)
}

Show SSO Event

SDK Method

sso_event.Find()

Return Values

Returns a files_sdk.SsoEvent value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

SsoEventFindParams Fields

FieldDescription
Id
int64
Required		Sso Event ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    sso_event "github.com/Files-com/files-sdk-go/v3/ssoevent"
)

ssoEvent, err := sso_event.Find(files_sdk.SsoEventFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(ssoEvent)

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
EventType
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.
EventErrors
array(string)		Event errors.
CreatedAt
date-time		Event create date/time.
BodyUrl
string		Link to log file.
UserId
int64		User ID.
Username
string		Username on Files.com for the SSO login attempt.
IdpUid
string		Identity Provider UID for the SSO login attempt.
Provider
string		SSO provider for the SSO login attempt.
ProviderLabel
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.