Data structure

Last Updated At: 2026-08-02 00:04:54

GroupInfo

User group information.

Referenced by the following interfaces: CreateGroup, GetGroup, ListGroups, UpdateGroup

name required NULL allowed type description
GroupId no no String User group ID.
Example: g-sd8sh8sdno***
MemberCount no no Int64 Number of group members.
Example: 1
IsSelected no no Bool If the input parameter FilterUsers is provided, return true when the user is in the user group; otherwise, return false.
Example: true
GroupName no no String User group name.
Example: group_name
Description no no String User group description.
Example: description
CreateTime no no String Creation time of the user group.
Example: 2025-01-03 12:12:23
GroupType no no String User group type. Manual: manually created; Synchronized: externally imported.
Example: Manual
UpdateTime no no String Modification time of the user group.
Example: 2025-01-03 12:12:23

ZoneStatistics

CIC space statistics.

Referenced by the following interfaces: GetZoneStatistics

name required NULL allowed type description
RoleConfigurationSyncCount no no Int64 Number of synchronized roles.
Example: 1
UserQuota no no Int64 User quota.
Example: 20
GroupQuota no no Int64 User group quota.
Example: 20
RoleConfigurationQuota no no Int64 Permission configuration quota.
Example: 20
SystemPolicyPerRoleConfigurationQuota no no Int64 System policy quota bound to the permission configuration.
Example: 20
UserCount no no Int64 Number of users.
Example: 1
GroupCount no no Int64 Number of user groups.
Example: 1
RoleConfigurationCount no no Int64 Number of permission configurations.
Example: 1
UserProvisioningCount no no Int64 Number of synchronized users.
Example: 1

JoinedGroups

User group joined by the user.

Referenced by the following interfaces: ListJoinedGroupsForUser

name required NULL allowed type description
GroupName no no String User group name.
Example: group_name
Description no no String User group description.
Example: description
GroupId no no String User group ID.
Example: g-sd8sh8sdno***
GroupType no no String User group type. Valid values:

Manual: manually created;
Synchronized: externally synchronized.
Example: Manual
JoinTime no no String Time of joining the user group.
Example: 2025-01-03 12:12:23

SAMLIdPCertificate

SAML signing certificate information.

Referenced by the following interfaces: ListExternalSAMLIdPCertificates

name required NULL allowed type description
SerialNumber no no String Certificate serial number.
Example: 1347934239****
PublicKey no no String Public key certificate in PEM format (Base64 encoded).
Example: nMIIBtjCCAV***
SignatureAlgorithm no no String Signature algorithm of the certificate.
Example: SHA256with***
NotAfter no no String Expiration time of the certificate.
Example: 2030-06-23 07:09:11
NotBefore no no String Creation time of the certificate.
Example: 2023-06-23 07:09:11
Subject no no String Certificate subject.
Example: 5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
X509Certificate no no String X509 certificate in PEM format.
Example: nMIIBtjCCAV***
Issuer no no String Certificate issuer.
Example: 5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
Version no no Int64 Certificate version.
Example: 1
CertificateId no no String Certificate ID.
Example: dp-c-2jd8923je29****

SAMLServiceProvider

SAML service provider information.

Referenced by the following interfaces: GetZoneSAMLServiceProviderInfo

name required NULL allowed type description
EntityId no no String https://XXX/saml/sp/z-sjw8ensa
Example: https://XXX/saml/sp/z-sjw8
*
ZoneId no no String Space ID.
Example: z-2d8shd8***
EncodedMetadataDocument no no String SP metadata document (Base64 encoded).
Example: JTNDJTNGeG1sJTIwdmVyc2lvbiUzRCUyMjEuMCUyMiUyMGVuY29kaW5nJTNE***
AcsUrl no no String SP ACS URL.
Example: https://XXX.com/saml/acs/swedx-22a20du2-x2je9****

TaskStatus

Task status information.

Referenced by the following interfaces: GetProvisioningTaskStatus

name required NULL allowed type description
FailureReason no no String Task failure cause.
Note:
This parameter is displayed only when the Status value is Failed.
Example: Failed
Status no no String Task status. Valid values: InProgress: The task is being executed; Success: The task executed successfully; Failed: The task execution failed.
Example: InProgress
TaskId no no String Task ID.
Example: t-x8jd983n****
TaskType no no String Task type. Valid values:
ProvisionRoleConfiguration: deploy permission configuration;
DeprovisionRoleConfiguration: Cancel permission configuration deployment;
CreateRoleAssignment: Assign permissions for a member account;
DeleteRoleAssignment: Remove permissions from a member account.
Example: CreateRoleAssignment

SCIMCredential

SCIM key.

Referenced by the following interfaces: ListSCIMCredentials

name required NULL allowed type description
CreateTime no no String Creation time of a SCIM key.
Example: 2025-01-03 12:12:23
ExpireTime no no String Expiration time of a SCIM key.
Example: 2025-01-03 12:12:23
ZoneId no no String Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters.
Example: z-2d8shd8***
Status no no String SCIM key status. Enabled: enabled. Disabled: disabled.
Example: Enabled
CredentialId no no String SCIM key ID, which starts with the scimcred- prefix, followed by 12 random digits/lowercase letters.
Example: scimcred-lkj****
CredentialType no no String SCIM key type.
Example: BearerToken

CreateUserInfo

Information on users created in batches.

Referenced by the following interfaces: BatchCreateUser

name required NULL allowed type description
UserName yes no String User name, which should be unique within the space and cannot be modified. It contains up to 64 characters, including digits, English letters, and special characters such as plus signs (+), equal signs (=), commas (,), periods (.), at signs (@), hyphens (-), and underscores (_).
Example: Alice
FirstName no no String Last name of the user, which contains up to 64 characters.
Example: Alice
LastName no no String First name of the user, which contains up to 64 characters.
Example: Alice
DisplayName no no String Display name of the user, which contains up to 256 characters.
Example: Alice
Description no no String User description, which contains up to 1024 characters.
Example: description
Email no no String Email address of the user, which must be unique within the directory and contains up to 128 characters.
Example: Alice@example.com
UserStatus no no String User status. Valid values: Enabled (default), Disabled.
Example: Enabled

RoleAssignmentInfo

Authorized member account information.

Referenced by the following interfaces: CreateRoleAssignment

name required NULL allowed type description
PrincipalId no no String ID of the object for CAM user synchronization.
When the PrincipalType value is Group, the value is the ID of an Identity Center user group (g-).
When the PrincipalType value is User, the value is the ID of an Identity Center user (u-
).
Example: u-xuec8dnd
PrincipalType no no String Type of the object for CAM user synchronization. Valid values:

User: an Identity Center user.
Group: an Identity Center user group.
Example: User
TargetUin no no Int64 UIN of the synchronized target account of the TCO.
Example: 111111111111
TargetType no no String Type of the synchronized target account of the TCO. ManagerUin: admin account; MemberUin: member account.
Example: MemberUin
RoleConfigurationId no no String Permission configuration ID.
Example: rc-sisjdia

AccountUserProvisioning

Configuration information on a member account synchronized by a user.

Referenced by the following interfaces: ListAccountsForUserProvisioning

name required NULL allowed type description
Uin no yes Int64 UIN of the synchronized target member account.
Example: 111111111111
Name no yes String Name of the synchronized target member account.
Example: member1
UserId no yes String User ID
Example: u-34nesn3u
SyncSubUin no yes String UIN of the sub-account created during synchronization.
Example: 222222222222
SyncSubName no yes String Name of the sub-account created during synchronization.
Example: sub_user

UserInfo

User information

Referenced by the following interfaces: CreateUser, GetUser, ListUsers, UpdateUser

name required NULL allowed type description
UserStatus no no String User status: Enabled, Disabled.
Example: Enabled
UserType no no String User type. Manual: manually created; Synchronized: externally imported.
Example: Manual
UserId no no String User ID
Example: u-34nesn3u
IsSelected no no Bool Whether selected
Example: false
UserName no no String Queried username.
Example: Alice
DisplayName no no String Display name of the user.
Example: Alice
Description no no String User description.
Example: description
Email no no String Email address of the user, which must be unique within the directory.
Example: Alice@example.com
CreateTime no no String Creation time of the user.
Example: 2025-01-03 12:12:23
UpdateTime no no String Modification time of the user.
Example: 2025-01-03 12:12:23
FirstName no no String First name of the user.
Example: Alice
LastName no no String Last name of the user.
Example: Alice

GroupIdAndUserId

User group ID and user IDs.

Referenced by the following interfaces: BatchAddUserToGroup, BatchRemoveUserFromGroup

name required NULL allowed type description
GroupId yes no String User Group ID
Example: g-sd8sh8sdno***
UserId yes no String User ID
Example: u-34nesn3u

GroupMembers

User information

Referenced by the following interfaces: ListGroupMembers

name required NULL allowed type description
UserType no no String User type. Manual: manually created; Synchronized: externally imported.
Example: Manual
UserId no no String User ID
Example: u-34nesn3u
JoinTime no no String Time when the user joins the user group.
Example: 2025-01-03 12:12:23
UserName no no String Queried username.
Example: Alice
DisplayName no no String Display name of the user.
Example: Alice
Description no no String User description.
Example: description
Email no no String Email address of the user, which must be unique within the directory.
Example: Alice@example.com
UserStatus no no String User status: Enabled, Disabled.
Example: Enabled

UserProvisioningsTask

Status information of the user synchronization task.

Referenced by the following interfaces: CreateUserSyncProvisioning, DeleteUserSyncProvisioning

name required NULL allowed type description
PrincipalType no no String Type of the object for CAM user synchronization. Valid values: User: an Identity Center user. Group: an Identity Center user group.
Example: User
PrincipalName no no String User name or user group name.
Example: user1
DeletionStrategy no no String Deletion policy: Delete, Keep.
Example: Delete
TaskId no no String Task ID.
Example: t-x8jd983n****
TaskType no no String Task type. StartProvisioning: Start the user synchronization; DeleteProvisioning: Delete the user synchronization.
Example: CreateRoleAssignment
TaskStatus no no String Task status. InProgress: The task is in progress; Failed: The task failed; Success: The task successful.
Example: InProgress
UserProvisioningId no no String User synchronization ID.
Example: up-sjisnw8ois
TargetUin no no Int64 UIN of the authorized target account of the TCO.
Example: 111111111111
TargetType no no String Type of the synchronized target account of the TCO. ManagerUin: admin account; MemberUin: member account.
Example: MemberUin
PrincipalId no no String ID of the object for CAM user synchronization. Valid values: When the PrincipalType value is Group, the value is the ID of an Identity Center user group (g-). When the PrincipalType value is User, the value is the ID of an Identity Center user (u-).
Example: u-xuec8dnd
DuplicationStrategy no no String Conflict policy. KeepBoth: Keep both; TakeOver: Replace.
Example: KeepBoth

UserSyncProvisioning

CAM user synchronization information.

Referenced by the following interfaces: CreateUserSyncProvisioning

name required NULL allowed type description
Description no no String Description.
Example: his is cam user 
PrincipalId no no String ID of the object for CAM user synchronization.
When the PrincipalType value is Group, the value is the ID of an Identity Center user group (g-).
When the PrincipalType value is User, the value is the ID of an Identity Center user (u-
).
Example: u-xuec8dnd
PrincipalType no no String Type of the object for CAM user synchronization. Valid values:

User: an Identity Center user.
Group: an Identity Center user group.
Example: User
TargetUin no no Int64 UIN of the synchronized target account of the TCO.
Example: 111111111111
DuplicationStrategy no no String Conflict policy. It indicates the handling policy for existence of a user with the same username when CIC users are synchronized to CAM. Valid values: KeepBoth: Keep both, that is, add the _cic suffix to the CIC user's username and then try to create a CAM user with the username when CIC users are synchronized to CAM and a user with the same username already exists in CAM; TakeOver: Replace, that is, directly replace the existing CAM user with the synchronized CIC user when CIC users are synchronized to CAM and a user with the same username already exists in CAM.
Example: KeepBoth
DeletionStrategy no no String Deletion policy. It indicates the handling policy for CAM users already synchronized when the CAM user synchronization is deleted. Valid values: Delete: Delete the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted; Keep: Keep the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted.
Example: Delete
TargetType no no String Type of the synchronized target account of the TCO. ManagerUin: admin account; MemberUin: member account.
Example: MemberUin

SAMLIdentityProviderConfiguration

SAML identity provider configuration information.

Referenced by the following interfaces: GetExternalSAMLIdentityProvider

name required NULL allowed type description
LoginUrl no no String IdP login URL.
Example: https://dev-xxxxx
CreateTime no no String Creation time.
Example: 2025-01-03 12:12:23
UpdateTime no no String Update time.
Example: 2025-01-03 12:12:23
EntityId no no String IdP identifier.
Example: http://www.***.com
SSOStatus no no String SSO enabling status. Valid values: Enabled, Disabled (default).
Example: Enbaled
EncodedMetadataDocument no no String IdP metadata document (Base64 encoded).
Example: PD94bWwgdmVyc2lvbj0i***
CertificateIds no no Array of String X509 certificate ID.
Example: dp-c-2jd8923je29****

TaskInfo

Task status information.

Referenced by the following interfaces: CreateRoleAssignment

name required NULL allowed type description
TaskId no no String Task ID.
Example: t-x8jd983n****
RoleConfigurationId no no String Permission configuration ID.
Example: rc-sisjdia
PrincipalId no no String Identity ID for the user authorization. If the identity type is CIC user, it is the user ID; if the identity type is user group, it is the user group ID.
Example: u-xuec8dnd
PrincipalType no no String Identity type for the user authorization. User: CIC user; Group: CIC user group.
Example: User
TaskType no no String Task type.
Example: CreateRoleAssignment
Status no no String InProgress: The task is being executed; Success: The task executed successfully; Failed: The task execution failed.
Example: InProgress
RoleConfigurationName no no String Permission configuration name.
Example: conf1
TargetUin no no Int64 UIN of the authorized target member account.
Example: 111111111111
TargetType no no String Type of the synchronized target account. ManagerUin: admin account; MemberUin: member account.
Example: MemberUin
FailureReason no yes String Failure reason
Example: Failed

UserProvisioning

User synchronization information.

Referenced by the following interfaces: GetUserSyncProvisioning, ListUserSyncProvisionings

name required NULL allowed type description
TargetName no no String Name of the target account of the TCO.
Example: user1
DuplicationStrategy no no String Conflict policy. It indicates the handling policy for existence of a user with the same username when CIC users are synchronized to CAM. Valid values: KeepBoth: Keep both, that is, add the _cic suffix to the CIC user's username and then try to create a CAM user with the username when CIC users are synchronized to CAM and a user with the same username already exists in CAM; TakeOver: Replace, that is, directly replace the existing CAM user with the synchronized CIC user when CIC users are synchronized to CAM and a user with the same username already exists in CAM.
Example: KeepBoth
DeletionStrategy no no String Deletion policy. It indicates the handling policy for CAM users already synchronized when the CAM user synchronization is deleted. Valid values: Delete: Delete the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted; Keep: Keep the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted.
Example: Delete
CreateTime no no String Creation time.
Example: 2025-01-03 12:12:23
UpdateTime no no String Update time.
Example: 2025-01-03 12:12:23
UserProvisioningId no no String CAM user synchronization status. Valid values:

Enabled: CAM user synchronization is enabled.
Disabled: CAM user synchronization is disabled.
Example: up-sjisnw8ois
Status no no String CAM user synchronization status. Valid values:
Enabled: CAM user synchronization is enabled.
Disabled: CAM user synchronization is disabled.
Example: Enabled
PrincipalName no no String Name of the object for CAM user synchronization.
When the PrincipalType value is Group, the value is the name of an Identity Center user group.
When the PrincipalType value is User, the value is the name of an Identity Center user.
Example: user1
PrincipalType no no String Type of the object for CAM user synchronization. Valid values:

User: an Identity Center user.
Group: an Identity Center user group.
Example: User
TargetUin no no Int64 UIN of the target account of the TCO.
Example: 111111111111
TargetType no no String Type of the synchronized target account of the TCO. ManagerUin: admin account; MemberUin: member account.
Example: MemberUin
Description no no String Description.
Example: description
PrincipalId no no String ID of the object for CAM user synchronization.
When the PrincipalType value is Group, the value is the ID of an Identity Center user group (g-).
When the PrincipalType value is User, the value is the ID of an Identity Center user (u-
).
Example: u-xuec8dnd

RoleConfiguration

CIC permission configuration.

Referenced by the following interfaces: CreateRoleConfiguration

name required NULL allowed type description
RelayState no no String Initial access page. It indicates the initial access page URL when CIC users use the access configuration to access member accounts.
Example: https://XXX
CreateTime no no String Creation time of the permission configuration.
Example: 2025-01-03 12:12:23
UpdateTime no no String Update time of the permission configuration.
Example: 2025-01-03 12:12:23
IsSelected no no Bool If the input parameter FilterTargets is provided, check whether the member account has been configured with permissions. If configured, return true; otherwise, return false.
Example: false
RoleConfigurationId no no String Permission configuration ID.
Example: rc-sisjdia
RoleConfigurationName no no String Permission configuration name.
Example: conf1
Description no no String Permission configuration description.
Example: description
SessionDuration no no Int64 Session duration. The maximum time a session is maintained when an Identity Center user accesses a member account by using the access configuration.
Unit: seconds.
Example: 60