List SSO Users¶

List the SSO users of the specified organization.

Operation Permissions¶

Applications assigned with the administrator policy in the OU.

Request Format¶

GET https://{apigw-address}/enos-iam-service/v2.3/user/sso/list

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The ID of the organization to which the SSO user belongs to. How to get orgId>>
userName	Query	Optional	String	The name of the SSO user.
email	Query	Optional	String	The email of the SSO user.
phone	Query	Optional	String	The mobile number of the SSO user.

Response Parameters¶

Name	Data Type	Description
users	Array of SSO User Struct	The list of SSO users. For more information, see SSO User Struct.

SSO User Struct ¶

Name	Data Type	Description
id	String	The SSO user ID.
name	String	The name of the SSO user.
type	Integer	The user type. 1: Normal user 2: OU Owner 3: OU Administrator
email	String	The email of the SSO user.
emailVerified	Boolean	Whether the email is verified.
emailVerifiedAt	String	The time the email was verified.
phoneArea	String	The country code of the SSO user’s mobile phone number.
phone	String	The mobile number of the SSO user.
phoneVerified	Boolean	Whether the mobile number is verified.
phoneVerifiedAt	String	The time the mobile number was verified.
organizationId	String	The OU that the SSO user belongs to.
state	Integer	The state of the account. `0`: Enabled `1`: Disabled
domain	String	The configured SSO identity provider name
authType	Integer	The user type. SSO users are classified under 2.
createTime	String	The time the SSO user was created.
createdByUserId	String	The user ID of the user who created the SSO user.
resourceId	String	The resource ID in IAM of the SSO user.
description	String	The description of the SSO user.
passwordState	Integer	The password state, which is usually 0. (Unused parameter)
passwordExpireTime	Long	The time the password will expire. This parameter is fixed at 0 for SSO users.
extra	Map	This parameter is usually empty. (Unused parameter)

Samples¶

Request Sample¶

url: https://{apigw-address}/enos-iam-service/v2.3/user/sso/list?orgId=yourOrgId
method: GET

Return Sample¶

{
  "fail": false,
  "success": true,
  "failed": false,
  "message": "",
  "users": [
    {
      "id": "userId",
      "name": "john",
      "type": 1,
      "email": "john@doe.com",
      "extra": {},
      "phone": "",
      "state": 0,
      "domain": "ssodemo",
      "authType": 2,
      "phoneArea": "86",
      "createTime": "2021-10-20 10:36:04.0",
      "resourceId": "rsrcId4695382",
      "description": "SSO USER",
      "emailVerified": true,
      "passwordState": 0,
      "phoneVerified": false,
      "organizationId": "orgId",
      "createdByUserId": "0",
      "emailVerifiedAt": "2021-10-20 10:36:04.0",
      "phoneVerifiedAt": "1970-01-01 00:00:00.0",
      "passwordExpireTime": 0
    },
    {
      "id": "userId2",
      "name": "jane",
      "type": 1,
      "email": "jane@doe.com",
      "extra": {},
      "phone": "1888888888",
      "state": 0,
      "domain": "ssodemo",
      "authType": 2,
      "phoneArea": "86",
      "createTime": "2021-10-20 10:29:45.0",
      "resourceId": "rsrcId9865829",
      "description": "SSO USER",
      "emailVerified": true,
      "passwordState": 0,
      "phoneVerified": false,
      "organizationId": "orgId",
      "createdByUserId": "0",
      "emailVerifiedAt": "2021-10-20 10:29:45.0",
      "phoneVerifiedAt": "1970-01-01 00:00:00.0",
      "passwordExpireTime": 0
    }
  ],
  "status": 0,
  "successful": true
}