Deprecated

The User Store API v1 is deprecated as of ProAuth 3.0. Use the User Store API v2 for all new integrations. v1 remains available for backward compatibility but will be removed in a future major release.

v1.0

ProAuth UserStore API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

CustomAuditTrail

Operations

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

---

GetAuditTrail

GET

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

Responses

OK

Content-Type

application/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

Content-Type

application/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

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"memberUsers": [...],

  

  

"parentGroups": [...],

  

  

"memberGroups": [...],

  

  

"metadata": [...],

  

  

"instanceId": "string"

  

}

]

---

GetAllGroupMembershipFromUser

GET

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

Responses

OK

Content-Type

application/json

[

]

---

SynchronizeAllGroup

GET

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

Responses

OK

Content-Type

application/json

---

GetGroups

GET

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

Responses

OK

Content-Type

application/json

[

]

---

CreateGroup

POST

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

Request Body

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

UpdateGroups

PUT

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

CreateGroups

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteGroups

DELETE

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

Request Body

[

]

Responses

No Content

---

PatchGroups

PATCH

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

Request Body

[

  

{

  

  

"ids": [...],

  

  

"patch": null

  

}

]

Responses

Accepted

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"memberUsers": [...],

  

  

"parentGroups": [...],

  

  

"memberGroups": [...],

  

  

"metadata": [...],

  

  

"instanceId": "string"

  

}

]

---

GetGroup

GET

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

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

UpdateGroup

PUT

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

Request Body

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

DeleteGroup

DELETE

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

Responses

No Content

---

PatchGroup

PATCH

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

Request Body

[

  

{

  

  

"op": "string",

  

  

"path": "string",

  

  

"from": "string",

  

  

"value": null

  

}

]

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

CreateOrUpdateGroup

POST

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

Request Body

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"memberUsers": [

  

  

{...}

  

],

  

"parentGroups": [

  

],

  

"memberGroups": [

  

],

  

"metadata": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

CreateOrUpdateGroups

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

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

Content-Type

application/json

[

  

{

  

  

"groupId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

GetGroupMetadata

GET

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

Responses

OK

Content-Type

application/json

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

UpdateGroupMetadata

PUT

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

Request Body

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "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

[

  

{

  

  

"op": "string",

  

  

"path": "string",

  

  

"from": "string",

  

  

"value": null

  

}

]

Responses

Accepted

Content-Type

application/json

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

GetGroupMetadatas

GET

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

Responses

OK

Content-Type

application/json

[

  

{

  

  

"groupId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

CreateGroupMetadata

POST

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

Request Body

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

UpdateGroupMetadata

PUT

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

CreateGroupMetadatas

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteGroupMetadatas

DELETE

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

Request Body

[

]

Responses

No Content

---

PatchGroupMetadatas

PATCH

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

Request Body

[

  

{

  

  

"ids": [...],

  

  

"patch": null

  

}

]

Responses

Accepted

Content-Type

application/json

[

  

{

  

  

"groupId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

CreateOrUpdateGroupMetadata

POST

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

Request Body

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"groupId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

CreateOrUpdateGroupMetadatas

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

User

Operations

GET/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}GET/api/userstore/v1/{userstore}/administration/UserPOST/api/userstore/v1/{userstore}/administration/UserGET/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}/statePUT/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/batchPOST/api/userstore/v1/{userstore}/administration/User/createorupdatePOST/api/userstore/v1/{userstore}/administration/User/createorupdate/batch

---

GetUser

GET

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

UpdateUser

PUT

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

Request Body

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

DeleteUser

DELETE

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

Responses

No Content

---

PatchUser

PATCH

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

Request Body

[

  

{

  

  

"op": "string",

  

  

"path": "string",

  

  

"from": "string",

  

  

"value": null

  

}

]

Responses

Accepted

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

GetUsers

GET

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

Responses

OK

Content-Type

application/json

[

  

{

  

  

"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,

  

  

"failedTemporaryLockAttempts": 0,

  

  

"lockedUntil": "string",

  

  

"passwordNeverExpires": true,

  

  

"canChangePasswordOnExpiration": true,

  

  

"passwordExpiration": "string",

  

  

"isInitialPassword": true,

  

  

"isPasswordChangeRequired": true,

  

  

"memberOfGroups": [...],

  

  

"userProfiles": [...],

  

  

"instanceId": "string"

  

}

]

---

CreateUser

POST

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

Request Body

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

GetUserByLoginName

GET

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

SynchronizeAllUser

GET

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

Responses

OK

Content-Type

application/json

---

SetInitialPassword

POST

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

Request Body

{

  

"expiration": "string",

  

"password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ResetInitialPasswordExpiration

POST

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ResetPassword

POST

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

Request Body

{

  

"password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

SendPasswordResetEmail

POST

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ResetPasswordTokenRequest

POST

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ResetPasswordTokenResponse

POST

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

Request Body

{

  

"token": "string",

  

"password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ResetAccessFailedCount

POST

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

ChangePassword

POST

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

Request Body

{

  

"oldPassword": "string",

  

"newPassword": "string"

}

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

SetUserState

POST

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

Responses

OK

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

UpdateUsers

PUT

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

CreateUsers

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteUsers

DELETE

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

Request Body

[

]

Responses

No Content

---

PatchUsers

PATCH

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

Request Body

[

]

Responses

Accepted

Content-Type

application/json

[

  

{

  

  

"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,

  

  

"failedTemporaryLockAttempts": 0,

  

  

"lockedUntil": "string",

  

  

"passwordNeverExpires": true,

  

  

"canChangePasswordOnExpiration": true,

  

  

"passwordExpiration": "string",

  

  

"isInitialPassword": true,

  

  

"isPasswordChangeRequired": true,

  

  

"memberOfGroups": [...],

  

  

"userProfiles": [...],

  

  

"instanceId": "string"

  

}

]

---

CreateOrUpdateUser

POST

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

Request Body

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"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,

  

"failedTemporaryLockAttempts": 0,

  

"lockedUntil": "string",

  

"passwordNeverExpires": true,

  

"canChangePasswordOnExpiration": true,

  

"passwordExpiration": "string",

  

"isInitialPassword": true,

  

"isPasswordChangeRequired": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"userProfiles": [

  

  

{...}

  

],

  

"instanceId": "string"

}

---

CreateOrUpdateUsers

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

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

Content-Type

application/json

[

  

{

  

  

"userId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

GetUserProfile

GET

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

Responses

OK

Content-Type

application/json

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

UpdateUserProfile

PUT

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

Request Body

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "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

[

  

{

  

  

"op": "string",

  

  

"path": "string",

  

  

"from": "string",

  

  

"value": null

  

}

]

Responses

Accepted

Content-Type

application/json

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

GetUserProfiles

GET

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

Responses

OK

Content-Type

application/json

[

  

{

  

  

"userId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

CreateUserProfile

POST

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

Request Body

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

UpdateUserProfile

PUT

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

CreateUserProfiles

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteUserProfiles

DELETE

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

Request Body

[

]

Responses

No Content

---

PatchUserProfiles

PATCH

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

Request Body

[

]

Responses

Accepted

Content-Type

application/json

[

  

{

  

  

"userId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"instanceId": "string"

  

}

]

---

CreateOrUpdateUserProfile

POST

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

Request Body

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"userId": "string",

  

"key": "string",

  

"value": "string",

  

"instanceId": "string"

}

---

CreateOrUpdateUserProfiles

POST

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

Request Body

[

]

Responses

OK

Content-Type

application/json

[

]

---

PublicAdmin

Operations

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

---

ChangePasswordPublic

POST

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

Request Body

{

  

"oldPassword": "string",

  

"newPassword": "string"

}

Responses

OK

---

ResetPasswordTokenResponsePublic

POST

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

Request Body

{

  

"token": "string",

  

"password": "string"

}

Responses

OK

---