getUserauthenticationMethods

Select

SaaS

Customer Managed

Used to fetch authentication methods of an existing user

Path Parameters

• userId int32 required

  Id of the User whose authentication method details have to be fetched

Query Parameters

• fetchAvailableMethodsOnly boolean

  Set as true to fetch the list of available authentication methods for the user

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• authenticationMethod string

  Possible values: [SAML, AD, LOCAL]

  Specifies authentication method used by user.

• authenticators object[]

  authenticationMethod string

  Possible values: [SAML, AD, LOCAL]

  Tells this authenticator belongs to which authentication method

  id int32

  Identity server id

  name string

  Identity server name

  type string

  Possible values: [SAML, ACTIVE_DIRECTORY, APPLE_DIRECTORY_SERVICE, ORACLE_DIRECTORY, OPEN_LDAP, LDAP_SERVER, OTHER]

  Identity server service type in Enum string

  samlType string

  Possible values: [UNKNOWN, AZURE, ADFS, OKTA]

  Name of the IdP. Available only if type is SAML.

  company object

  id int32

  name string
• error object

  errorMessage string

  errorCode int32

{
  "authenticationMethod": "SAML",
  "authenticators": [
    {
      "authenticationMethod": "SAML",
      "id": 0,
      "name": "string",
      "type": "SAML",
      "samlType": "UNKNOWN",
      "company": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

Requested Details not found

Loading...