ProAuth Documentation

Appearance

v1.0

ProAuth UserStore API v1.0​

Download OpenAPI Document

ProAuth UserStore API

GetAuditTrail​

GET
/api/userstore/v1/{userstore}/administration/CustomAuditTrail/{id}

Responses​

OK

application/json
JSON
{
"id": 0,
"timestamp": "string",
"user": "string",
"area": "string",
"primaryKey": "string",
"category": "string",
"action": "string",
"dataSource": "string",
"originalContent": "string",
"currentContent": "string",
"signature": "string",
"signaturePublicKeyInfo": "string"
}

GetAuditTrails​

GET
/api/userstore/v1/{userstore}/administration/CustomAuditTrail

Responses​

OK

application/json
JSON
[
{
"id": 0,
"timestamp": "string",
"user": "string",
"area": "string",
"primaryKey": "string",
"category": "string",
"action": "string",
"dataSource": "string",
"originalContent": "string",
"currentContent": "string",
"signature": "string",
"signaturePublicKeyInfo": "string"
}
]

Group​

Operations​

GET/api/userstore/v1/{userstore}/administration/Group/parentGroup/{parentGroupId}/membershipGET/api/userstore/v1/{userstore}/administration/Group/user/{userid}/membershipGET/api/userstore/v1/{userstore}/administration/Group/synchronizeGET/api/userstore/v1/{userstore}/administration/GroupPOST/api/userstore/v1/{userstore}/administration/GroupPUT/api/userstore/v1/{userstore}/administration/Group/batchPOST/api/userstore/v1/{userstore}/administration/Group/batchDELETE/api/userstore/v1/{userstore}/administration/Group/batchPATCH/api/userstore/v1/{userstore}/administration/Group/batchGET/api/userstore/v1/{userstore}/administration/Group/{id}PUT/api/userstore/v1/{userstore}/administration/Group/{id}DELETE/api/userstore/v1/{userstore}/administration/Group/{id}PATCH/api/userstore/v1/{userstore}/administration/Group/{id}POST/api/userstore/v1/{userstore}/administration/Group/createorupdatePOST/api/userstore/v1/{userstore}/administration/Group/createorupdate/batch

GetAllGroupMembershipFromGroup​

GET
/api/userstore/v1/{userstore}/administration/Group/parentGroup/{parentGroupId}/membership

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

GetAllGroupMembershipFromUser​

GET
/api/userstore/v1/{userstore}/administration/Group/user/{userid}/membership

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

SynchronizeAllGroup​

GET
/api/userstore/v1/{userstore}/administration/Group/synchronize

Responses​

OK

application/json

GetGroups​

GET
/api/userstore/v1/{userstore}/administration/Group

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

CreateGroup​

POST
/api/userstore/v1/{userstore}/administration/Group

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

UpdateGroups​

PUT
/api/userstore/v1/{userstore}/administration/Group/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

CreateGroups​

POST
/api/userstore/v1/{userstore}/administration/Group/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

DeleteGroups​

DELETE
/api/userstore/v1/{userstore}/administration/Group/batch

Request Body​

JSON
[
"string"
]

Responses​

No Content

PatchGroups​

PATCH
/api/userstore/v1/{userstore}/administration/Group/batch

Request Body​

JSON
[
{
"ids": [...],
"patch": {...}
}
]

Responses​

Accepted

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

GetGroup​

GET
/api/userstore/v1/{userstore}/administration/Group/{id}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

UpdateGroup​

PUT
/api/userstore/v1/{userstore}/administration/Group/{id}

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

DeleteGroup​

DELETE
/api/userstore/v1/{userstore}/administration/Group/{id}

Responses​

No Content

PatchGroup​

PATCH
/api/userstore/v1/{userstore}/administration/Group/{id}

Request Body​

JSON
{
"operations": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

CreateOrUpdateGroup​

POST
/api/userstore/v1/{userstore}/administration/Group/createorupdate

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [
{...}
],
"parentGroups": [
{...}
],
"memberGroups": [
{...}
],
"metadata": [
{...}
]
}

CreateOrUpdateGroups​

POST
/api/userstore/v1/{userstore}/administration/Group/createorupdate/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"name": "string",
"memberUsers": [...],
"parentGroups": [...],
"memberGroups": [...],
"metadata": [...]
}
]

GroupMetadata​

Operations​

GET/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/groupIdGET/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}PUT/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}DELETE/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}PATCH/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}GET/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadataPOST/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadataPUT/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batchPOST/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batchDELETE/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batchPATCH/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batchPOST/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/createorupdatePOST/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/createorupdate/batch

GetGroupMetadataByGroupId​

GET
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/groupId

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

GetGroupMetadata​

GET
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

UpdateGroupMetadata​

PUT
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}

Request Body​

JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

DeleteGroupMetadata​

DELETE
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}

Responses​

No Content

PatchGroupMetadata​

PATCH
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}

Request Body​

JSON
{
"operations": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

GetGroupMetadatas​

GET
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

CreateGroupMetadata​

POST
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata

Request Body​

JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

UpdateGroupMetadata​

PUT
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}

Request Body​

JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

CreateGroupMetadatas​

POST
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batch

Request Body​

JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

DeleteGroupMetadatas​

DELETE
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batch

Request Body​

JSON
[
{
"item1": "string",
"item2": "string"
}
]

Responses​

No Content

PatchGroupMetadatas​

PATCH
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/batch

Request Body​

JSON
[
{
"ids": [...],
"patch": {...}
}
]

Responses​

Accepted

application/json
JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

CreateOrUpdateGroupMetadata​

POST
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/createorupdate

Request Body​

JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}

CreateOrUpdateGroupMetadatas​

POST
/api/userstore/v1/{userstore}/administration/Group/{groupId}/GroupMetadata/createorupdate/batch

Request Body​

JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"groupId": "string",
"key": "string",
"value": "string"
}
]

ChangePasswordPublic​

POST
/api/userstore/v1/{userstore}/PublicAdmin/user/loginname/{loginName}/password/change

Request Body​

application/json
JSON
{
"oldPassword": "string",
"newPassword": "string"
}

Responses​

OK

ResetPasswordTokenResponsePublic​

POST
/api/userstore/v1/{userstore}/PublicAdmin/user/loginname/{loginname}/password/reset/response

Request Body​

application/json
JSON
{
"password": "string",
"token": "string"
}

Responses​

OK

User​

Operations​

GET/api/userstore/v1/{userstore}/administration/User/loginname/{userName}GET/api/userstore/v1/{userstore}/administration/User/synchronizePOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/initialPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/initial/resetPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/resetPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/sendresetemailPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/requestPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/responsePOST/api/userstore/v1/{userstore}/administration/User/{userId}/lockout/resetPOST/api/userstore/v1/{userstore}/administration/User/{userId}/password/changePOST/api/userstore/v1/{userstore}/administration/User/{userId}/stateGET/api/userstore/v1/{userstore}/administration/UserPOST/api/userstore/v1/{userstore}/administration/UserPUT/api/userstore/v1/{userstore}/administration/User/batchPOST/api/userstore/v1/{userstore}/administration/User/batchDELETE/api/userstore/v1/{userstore}/administration/User/batchPATCH/api/userstore/v1/{userstore}/administration/User/batchGET/api/userstore/v1/{userstore}/administration/User/{id}PUT/api/userstore/v1/{userstore}/administration/User/{id}DELETE/api/userstore/v1/{userstore}/administration/User/{id}PATCH/api/userstore/v1/{userstore}/administration/User/{id}POST/api/userstore/v1/{userstore}/administration/User/createorupdatePOST/api/userstore/v1/{userstore}/administration/User/createorupdate/batch

GetUserByLoginName​

GET
/api/userstore/v1/{userstore}/administration/User/loginname/{userName}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

SynchronizeAllUser​

GET
/api/userstore/v1/{userstore}/administration/User/synchronize

Responses​

OK

application/json

SetInitialPassword​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/initial

Request Body​

JSON
{
"password": "string",
"expiration": "string"
}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ResetInitialPasswordExpiration​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/initial/reset

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ResetPassword​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset

Request Body​

JSON
{
"password": "string"
}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

SendPasswordResetEmail​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/sendresetemail

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ResetPasswordTokenRequest​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/request

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ResetPasswordTokenResponse​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/reset/response

Request Body​

JSON
{
"password": "string",
"token": "string"
}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ResetAccessFailedCount​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/lockout/reset

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

ChangePassword​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/password/change

Request Body​

JSON
{
"oldPassword": "string",
"newPassword": "string"
}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

SetUserState​

POST
/api/userstore/v1/{userstore}/administration/User/{userId}/state

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

GetUsers​

GET
/api/userstore/v1/{userstore}/administration/User

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

CreateUser​

POST
/api/userstore/v1/{userstore}/administration/User

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

UpdateUsers​

PUT
/api/userstore/v1/{userstore}/administration/User/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

CreateUsers​

POST
/api/userstore/v1/{userstore}/administration/User/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

DeleteUsers​

DELETE
/api/userstore/v1/{userstore}/administration/User/batch

Request Body​

JSON
[
"string"
]

Responses​

No Content

PatchUsers​

PATCH
/api/userstore/v1/{userstore}/administration/User/batch

Request Body​

JSON
[
{
"ids": [...],
"patch": {...}
}
]

Responses​

Accepted

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

GetUser​

GET
/api/userstore/v1/{userstore}/administration/User/{id}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

UpdateUser​

PUT
/api/userstore/v1/{userstore}/administration/User/{id}

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

DeleteUser​

DELETE
/api/userstore/v1/{userstore}/administration/User/{id}

Responses​

No Content

PatchUser​

PATCH
/api/userstore/v1/{userstore}/administration/User/{id}

Request Body​

JSON
{
"operations": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

CreateOrUpdateUser​

POST
/api/userstore/v1/{userstore}/administration/User/createorupdate

Request Body​

JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [
{...}
],
"userProfiles": [
{...}
]
}

CreateOrUpdateUsers​

POST
/api/userstore/v1/{userstore}/administration/User/createorupdate/batch

Request Body​

JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"id": "string",
"externalUniqueIdentifier": "string",
"loginName": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"emailAddressConfirmed": true,
"userValidFrom": "string",
"userValidTo": "string",
"isUserActive": true,
"isUserLockEnabled": true,
"isUserLocked": true,
"failedUserLoginAttempts": 0,
"passwordNeverExpires": true,
"canChangePasswordOnExpiration": true,
"passwordExpiration": "string",
"isInitialPassword": true,
"isPasswordChangeRequired": true,
"memberOfGroups": [...],
"userProfiles": [...]
}
]

UserProfile​

Operations​

GET/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/userIdGET/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}PUT/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}DELETE/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}PATCH/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}GET/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfilePOST/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfilePUT/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batchPOST/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batchDELETE/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batchPATCH/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batchPOST/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/createorupdatePOST/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/createorupdate/batch

GetUserProfilesByUserId​

GET
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/userId

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

GetUserProfile​

GET
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}

Responses​

OK

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

UpdateUserProfile​

PUT
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}

Request Body​

JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

DeleteUserProfile​

DELETE
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}

Responses​

No Content

PatchUserProfile​

PATCH
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}

Request Body​

JSON
{
"operations": [
{...}
]
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

GetUserProfiles​

GET
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

CreateUserProfile​

POST
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile

Request Body​

JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

UpdateUserProfile​

PUT
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/{key}

Request Body​

JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

Responses​

Accepted

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

CreateUserProfiles​

POST
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batch

Request Body​

JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

DeleteUserProfiles​

DELETE
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batch

Request Body​

JSON
[
{
"item1": "string",
"item2": "string"
}
]

Responses​

No Content

PatchUserProfiles​

PATCH
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/batch

Request Body​

JSON
[
{
"ids": [...],
"patch": {...}
}
]

Responses​

Accepted

application/json
JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

CreateOrUpdateUserProfile​

POST
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/createorupdate

Request Body​

JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

Responses​

Created

application/json
JSON
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}

CreateOrUpdateUserProfiles​

POST
/api/userstore/v1/{userstore}/administration/user/{userId}/UserProfile/createorupdate/batch

Request Body​

JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]

Responses​

OK

application/json
JSON
[
{
"instanceId": "string",
"userId": "string",
"key": "string",
"value": "string"
}
]