Download OpenAPI specification:Download
API to manage identity and access management.
The permission to create
| description | string Nullable The description of the permission, can change after creation |
| id | string Nullable The identity of the permission, can not be changed |
{ }| id required | string Nullable The document id for the permission |
request
| description | string Nullable The description of the permission, can change after creation |
{ }| tenantId required | string |
| name | string Nullable Provider name |
| type | string (ProviderType) Enum: "Oidc" "Saml" Identity Provider type. |
| userType | string (IdpUserType) Enum: "Staff" "Shoppers" User type |
| clientId | string Nullable A public identifier for app |
| clientSecret | string Nullable A secret known only to the application and the authorization server |
| issuer | string Nullable Issuer URL |
| externalIdField | string (IdpExternalKey) Enum: "Uid" "Email" "PhoneNumber" The IdP external ID keys of the linked provider that is used for user linking |
{ }| id required | string Nullable |
| tenantId required | string |
| name | string Nullable Provider name |
| clientId | string Nullable A public identifier for app |
| clientSecret | string Nullable A secret known only to the application and the authorization server |
| issuer | string Nullable Issuer URL |
| externalIdField | string (IdpExternalKey) Enum: "Uid" "Email" "PhoneNumber" The IdP external ID keys of the linked provider that is used for user linking |
{ }| searchString | string Nullable |
| sortBy | string (SortBy) Enum: "Id" "Name" |
| direction | string (SortDirection) Enum: "Asc" "Desc" |
| offset | integer <int32> Nullable |
| limit | integer <int32> Nullable |
The role to create
| name | string Nullable The name of the role, can change after creation |
| permissions | Array of strings Nullable A list of permissions |
| id | string Nullable The identity of the role, can not be changed |
{ }| id required | string Nullable The document id for the role |
The role object to update
| name | string Nullable The name of the role, can change after creation |
| permissions | Array of strings Nullable A list of permissions |
{ }The tenant to create
| name | string Nullable The name of the tenant, can change after creation |
| alias | string Nullable The tenant alias. It must be unique |
| adminUser | string Nullable The tenant admin user |
{ }| id required | string Nullable The document id for the tenant |
| name | string Nullable The name of the tenant, can change after creation |
| alias | string Nullable The tenant alias. It must be unique |
| adminUser | string Nullable The tenant admin user |
{ }| tenantId required | string |
| searchString | string Nullable |
| sortBy | string (SortBy) Enum: "Id" "Name" |
| direction | string (SortDirection) Enum: "Asc" "Desc" |
| offset | integer <int32> Nullable |
| limit | integer <int32> Nullable |
| tenantId required | string |
The userGroup to create
| name | string Nullable The name of the user group, can change after creation |
| description | string Nullable A text describing this group max 200 characters |
{ }| id required | string Nullable The document id for the user group |
| tenantId required | string |
the new object to replace the old
| name | string Nullable The name of the user group, can change after creation |
| description | string Nullable A text describing this group max 200 characters |
{ }| id required | string Nullable The user group document ID |
| tenantId required | string |
| roleId required | string the role document ID |
| tenantId required | string |
| displayName | string Nullable The display name for the user |
string Nullable The email address for the user |
{ }| tenantId required | string |
| newPassword | string Nullable The new password for the user |
{ }| userId required | string Nullable The document id for the user |
| tenantId required | string |
| UserGroupDocumentId | string Nullable The document id for the user group |
| userId required | string Nullable The document id of the user. |
| id required | string Nullable The document id for the user group link |
| tenantId required | string |
| tenantId required | string |
The user to create
| name | string Nullable The name of the user |
string Nullable The email of the user | |
| password | string Nullable The password of the user |
| type | string (UserType) Enum: "Federated" "Standalone" User type |
| scope | string (UserScope) Enum: "Staff" "Shoppers" User scope |
| externalId | string Nullable The external user ID |
| externalProviderId | string Nullable The external provider ID |
{ }| id required | string Nullable The document id for the user |
| tenantId required | string |
| name required | string The name of user |