Class ScimClient

Index

Constructors

Methods

createAccountGroup createAccountServicePrincipal createAccountUser createGroup createServicePrincipal createUser deleteAccountGroup deleteAccountServicePrincipal deleteAccountUser deleteGroup deleteServicePrincipal deleteUser getAccountGroup getAccountServicePrincipal getAccountUser getGroup getPermissionLevels getPermissions getServicePrincipal getUser listAccountGroups listAccountGroupsIter listAccountServicePrincipals listAccountServicePrincipalsIter listAccountUsers listAccountUsersIter listGroups listGroupsIter listServicePrincipals listServicePrincipalsIter listUsers listUsersIter me patchAccountGroup patchAccountServicePrincipal patchAccountUser patchGroup patchServicePrincipal patchUser setPermissions updateAccountGroup updateAccountServicePrincipal updateAccountUser updateGroup updatePermissions updateServicePrincipal updateUser

Constructors

constructor

new ScimClient(options: ClientOptions): ScimClient
Parameters
- options: ClientOptions
Returns ScimClient
- Defined in client.ts:129

Methods

createAccountGroup

createAccountGroup(
req: CreateAccountGroupRequest,
options?: CallOptions,
): Promise<AccountGroup>
Creates a group in the account with a unique name, using the supplied group details.
Parameters
- req: CreateAccountGroupRequest
- Optionaloptions: CallOptions
Returns Promise<AccountGroup>
- Defined in client.ts:145

createAccountServicePrincipal

createAccountServicePrincipal(
req: CreateAccountServicePrincipalRequest,
options?: CallOptions,
): Promise<AccountServicePrincipal>
Creates a new service principal in the account.
Parameters
- req: CreateAccountServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<AccountServicePrincipal>
- Defined in client.ts:333

createAccountUser

createAccountUser(
req: CreateAccountUserRequest,
options?: CallOptions,
): Promise<AccountUser>
Creates a new user in the account. This new user will also be added to the account.
Parameters
- req: CreateAccountUserRequest
- Optionaloptions: CallOptions
Returns Promise<AccountUser>
- Defined in client.ts:532

createGroup

createGroup(req: CreateGroupRequest, options?: CallOptions): Promise<Group>
Creates a group in the workspace with a unique name, using the supplied group details.
Parameters
- req: CreateGroupRequest
- Optionaloptions: CallOptions
Returns Promise<Group>
- Defined in client.ts:777

createServicePrincipal

createServicePrincipal(
req: CreateServicePrincipalRequest,
options?: CallOptions,
): Promise<ServicePrincipal>
Creates a new service principal in the workspace.
Parameters
- req: CreateServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<ServicePrincipal>
- Defined in client.ts:975

createUser

createUser(req: CreateUserRequest, options?: CallOptions): Promise<User>
Creates a new user in the workspace. This new user will also be added to the account.
Parameters
- req: CreateUserRequest
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in client.ts:1189

deleteAccountGroup

deleteAccountGroup(
req: DeleteAccountGroupRequest,
options?: CallOptions,
): Promise<void>
Deletes a group from the account.
Parameters
- req: DeleteAccountGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:172

deleteAccountServicePrincipal

deleteAccountServicePrincipal(
req: DeleteAccountServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Delete a single service principal in the account.
Parameters
- req: DeleteAccountServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:363

deleteAccountUser

deleteAccountUser(
req: DeleteAccountUserRequest,
options?: CallOptions,
): Promise<void>
Deletes a user. Deleting a user from a account also removes objects associated with the user.
Parameters
- req: DeleteAccountUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:559

deleteGroup

deleteGroup(req: DeleteGroupRequest, options?: CallOptions): Promise<void>
Deletes a group from the workspace.
Parameters
- req: DeleteGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:807

deleteServicePrincipal

deleteServicePrincipal(
req: DeleteServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Delete a single service principal in the workspace.
Parameters
- req: DeleteServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1008

deleteUser

deleteUser(req: DeleteUserRequest, options?: CallOptions): Promise<void>
Deletes a user. Deleting a user from a workspace also removes objects associated with the user.
Parameters
- req: DeleteUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1219

getAccountGroup

getAccountGroup(
req: GetAccountGroupRequest,
options?: CallOptions,
): Promise<AccountGroup>
Gets the information for a specific group in the account.
Parameters
- req: GetAccountGroupRequest
- Optionaloptions: CallOptions
Returns Promise<AccountGroup>
- Defined in client.ts:192

getAccountServicePrincipal

getAccountServicePrincipal(
req: GetAccountServicePrincipalRequest,
options?: CallOptions,
): Promise<AccountServicePrincipal>
Gets the details for a single service principal define in the account.
Parameters
- req: GetAccountServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<AccountServicePrincipal>
- Defined in client.ts:383

getAccountUser

getAccountUser(
req: GetAccountUserRequest,
options?: CallOptions,
): Promise<AccountUser>
Gets information for a specific user in account.
Parameters
- req: GetAccountUserRequest
- Optionaloptions: CallOptions
Returns Promise<AccountUser>
- Defined in client.ts:579

getGroup

getGroup(req: GetGroupRequest, options?: CallOptions): Promise<Group>
Gets the information for a specific group in the workspace.
Parameters
- req: GetGroupRequest
- Optionaloptions: CallOptions
Returns Promise<Group>
- Defined in client.ts:830

getPermissionLevels

getPermissionLevels(
_req: GetPasswordPermissionLevelsRequest,
options?: CallOptions,
): Promise<GetPasswordPermissionLevelsResponse>
Gets the permission levels that a user can have on an object.
Parameters
- _req: GetPasswordPermissionLevelsRequest
- Optionaloptions: CallOptions
Returns Promise<GetPasswordPermissionLevelsResponse>
- Defined in client.ts:1242

getPermissions

getPermissions(
_req: GetPasswordPermissionsRequest,
options?: CallOptions,
): Promise<PasswordPermissions>
Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
Parameters
- _req: GetPasswordPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PasswordPermissions>
- Defined in client.ts:1274

getServicePrincipal

getServicePrincipal(
req: GetServicePrincipalRequest,
options?: CallOptions,
): Promise<ServicePrincipal>
Gets the details for a single service principal define in the workspace.
Parameters
- req: GetServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<ServicePrincipal>
- Defined in client.ts:1031

getUser

getUser(req: GetUserRequest, options?: CallOptions): Promise<User>
Gets information for a specific user in workspace.
Parameters
- req: GetUserRequest
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in client.ts:1303

listAccountGroups

listAccountGroups(
req: ListAccountGroupsRequest,
options?: CallOptions,
): Promise<ListAccountGroupsResponse>
Gets all details of the groups associated with the account. As of 08/22/2025, this endpoint will no longer return members. Instead, members should be retrieved by iterating through Get group details. Existing accounts that rely on this attribute will not be impacted and will continue receiving member data as before.
Parameters
- req: ListAccountGroupsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAccountGroupsResponse>
- Defined in client.ts:223

listAccountGroupsIter

listAccountGroupsIter(
req: ListAccountGroupsRequest,
options?: CallOptions,
): AsyncGenerator<AccountGroup>
Parameters
- req: ListAccountGroupsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<AccountGroup>
- Defined in client.ts:272

listAccountServicePrincipals

listAccountServicePrincipals(
req: ListAccountServicePrincipalsRequest,
options?: CallOptions,
): Promise<ListAccountServicePrincipalsResponse>
Gets the set of service principals associated with a account.
Parameters
- req: ListAccountServicePrincipalsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAccountServicePrincipalsResponse>
- Defined in client.ts:409

listAccountServicePrincipalsIter

listAccountServicePrincipalsIter(
req: ListAccountServicePrincipalsRequest,
options?: CallOptions,
): AsyncGenerator<AccountServicePrincipal>
Parameters
- req: ListAccountServicePrincipalsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<AccountServicePrincipal>
- Defined in client.ts:461

listAccountUsers

listAccountUsers(
req: ListAccountUsersRequest,
options?: CallOptions,
): Promise<ListAccountUsersResponse>
Gets details for all the users associated with a account.
Parameters
- req: ListAccountUsersRequest
- Optionaloptions: CallOptions
Returns Promise<ListAccountUsersResponse>
- Defined in client.ts:629

listAccountUsersIter

listAccountUsersIter(
req: ListAccountUsersRequest,
options?: CallOptions,
): AsyncGenerator<AccountUser>
Parameters
- req: ListAccountUsersRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<AccountUser>
- Defined in client.ts:678

listGroups

listGroups(
req: ListGroupsRequest,
options?: CallOptions,
): Promise<ListGroupsResponse>
Gets all details of the groups associated with the workspace.
Parameters
- req: ListGroupsRequest
- Optionaloptions: CallOptions
Returns Promise<ListGroupsResponse>
- Defined in client.ts:856

listGroupsIter

listGroupsIter(
req: ListGroupsRequest,
options?: CallOptions,
): AsyncGenerator<Group>
Parameters
- req: ListGroupsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Group>
- Defined in client.ts:908

listServicePrincipals

listServicePrincipals(
req: ListServicePrincipalsRequest,
options?: CallOptions,
): Promise<ListServicePrincipalResponse>
Gets the set of service principals associated with a workspace.
Parameters
- req: ListServicePrincipalsRequest
- Optionaloptions: CallOptions
Returns Promise<ListServicePrincipalResponse>
- Defined in client.ts:1060

listServicePrincipalsIter

listServicePrincipalsIter(
req: ListServicePrincipalsRequest,
options?: CallOptions,
): AsyncGenerator<ServicePrincipal>
Parameters
- req: ListServicePrincipalsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ServicePrincipal>
- Defined in client.ts:1115

listUsers

listUsers(
req: ListUsersRequest,
options?: CallOptions,
): Promise<ListUsersResponse>
Gets details for all the users associated with a workspace.
Parameters
- req: ListUsersRequest
- Optionaloptions: CallOptions
Returns Promise<ListUsersResponse>
- Defined in client.ts:1353

listUsersIter

listUsersIter(
req: ListUsersRequest,
options?: CallOptions,
): AsyncGenerator<User>
Parameters
- req: ListUsersRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<User>
- Defined in client.ts:1405

me

me(req: MeRequest, options?: CallOptions): Promise<User>
Get details about the current method caller's identity.
Parameters
- req: MeRequest
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in client.ts:742

patchAccountGroup

patchAccountGroup(
req: PatchAccountGroupRequest,
options?: CallOptions,
): Promise<void>
Partially updates the details of a group.
Parameters
- req: PatchAccountGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:291

patchAccountServicePrincipal

patchAccountServicePrincipal(
req: PatchAccountServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Partially updates the details of a single service principal in the account.
Parameters
- req: PatchAccountServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:480

patchAccountUser

patchAccountUser(
req: PatchAccountUserRequest,
options?: CallOptions,
): Promise<void>
Partially updates a user resource by applying the supplied operations on specific user attributes. The userName and emails attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).
Parameters
- req: PatchAccountUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:700

patchGroup

patchGroup(req: PatchGroupRequest, options?: CallOptions): Promise<void>
Partially updates the details of a group.
Parameters
- req: PatchGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:927

patchServicePrincipal

patchServicePrincipal(
req: PatchServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Partially updates the details of a single service principal in the workspace.
Parameters
- req: PatchServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1134

patchUser

patchUser(req: PatchUserRequest, options?: CallOptions): Promise<void>
Partially updates a user resource by applying the supplied operations on specific user attributes. The userName and emails attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).
Parameters
- req: PatchUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1427

setPermissions

setPermissions(
req: PasswordPermissionsRequest,
options?: CallOptions,
): Promise<PasswordPermissions>
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.
Parameters
- req: PasswordPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PasswordPermissions>
- Defined in client.ts:1448

updateAccountGroup

updateAccountGroup(
req: UpdateAccountGroupRequest,
options?: CallOptions,
): Promise<void>
Updates the details of a group by replacing the entire group entity.
Parameters
- req: UpdateAccountGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:312

updateAccountServicePrincipal

updateAccountServicePrincipal(
req: UpdateAccountServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Updates the details of a single service principal.

This action replaces the existing service principal with the same name.
Parameters
- req: UpdateAccountServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:508

updateAccountUser

updateAccountUser(
req: UpdateAccountUserRequest,
options?: CallOptions,
): Promise<void>
Replaces a user's information with the data supplied in request.
Parameters
- req: UpdateAccountUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:721

updateGroup

updateGroup(req: UpdateGroupRequest, options?: CallOptions): Promise<void>
Updates the details of a group by replacing the entire group entity.
Parameters
- req: UpdateGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:951

updatePermissions

updatePermissions(
req: PasswordPermissionsRequest,
options?: CallOptions,
): Promise<PasswordPermissions>
Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
Parameters
- req: PasswordPermissionsRequest
- Optionaloptions: CallOptions
Returns Promise<PasswordPermissions>
- Defined in client.ts:1478

updateServicePrincipal

updateServicePrincipal(
req: UpdateServicePrincipalRequest,
options?: CallOptions,
): Promise<void>
Updates the details of a single service principal.

This action replaces the existing service principal with the same name.
Parameters
- req: UpdateServicePrincipalRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1162

updateUser

updateUser(req: UpdateUserRequest, options?: CallOptions): Promise<void>
Replaces a user's information with the data supplied in request.
Parameters
- req: UpdateUserRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:1508

Class ScimClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ScimClient

Methods

createAccountGroup

Parameters

Returns Promise<AccountGroup>

createAccountServicePrincipal

Parameters

Returns Promise<AccountServicePrincipal>

createAccountUser

Parameters

Returns Promise<AccountUser>

createGroup

Parameters

Returns Promise<Group>

createServicePrincipal

Parameters

Returns Promise<ServicePrincipal>

createUser

Parameters

Returns Promise<User>

deleteAccountGroup

Parameters

Returns Promise<void>

deleteAccountServicePrincipal

Parameters

Returns Promise<void>

deleteAccountUser

Parameters

Returns Promise<void>

deleteGroup

Parameters

Returns Promise<void>

deleteServicePrincipal

Parameters

Returns Promise<void>

deleteUser

Parameters

Returns Promise<void>

getAccountGroup

Parameters

Returns Promise<AccountGroup>

getAccountServicePrincipal

Parameters

Returns Promise<AccountServicePrincipal>

getAccountUser

Parameters

Returns Promise<AccountUser>

getGroup

Parameters

Returns Promise<Group>

getPermissionLevels

Parameters

Returns Promise<GetPasswordPermissionLevelsResponse>

getPermissions

Parameters

Returns Promise<PasswordPermissions>

getServicePrincipal

Parameters

Returns Promise<ServicePrincipal>

getUser

Parameters

Returns Promise<User>

listAccountGroups

Parameters

Returns Promise<ListAccountGroupsResponse>

listAccountGroupsIter

Parameters

Returns AsyncGenerator<AccountGroup>

listAccountServicePrincipals

Parameters

Returns Promise<ListAccountServicePrincipalsResponse>

listAccountServicePrincipalsIter

Parameters