Version v3.0.0
User Store API v2
Current Version
This is the current and recommended version of the User Store API. For the deprecated v1 API, see User Store API v1.
The User Store API v2 manages users, groups, memberships, profiles, and credentials within a specific user store instance. All endpoints are scoped by the {userstore} route value. The generated .NET client uses typed identifiers such as IdpInstanceId, UserId, and GroupId, while the HTTP API still uses UUID strings in paths and JSON payloads.
For cross-cutting behavior that is easier to explain outside the generated endpoint reference, see:
GetAuditTrail
GET
/api/userstore/v2/{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/v2/{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/v2/{userstore}/administration/GroupPOST/api/userstore/v2/{userstore}/administration/GroupPUT/api/userstore/v2/{userstore}/administration/Group/batchPOST/api/userstore/v2/{userstore}/administration/Group/batchDELETE/api/userstore/v2/{userstore}/administration/Group/batchGET/api/userstore/v2/{userstore}/administration/Group/{id}PUT/api/userstore/v2/{userstore}/administration/Group/{id}DELETE/api/userstore/v2/{userstore}/administration/Group/{id}PATCH/api/userstore/v2/{userstore}/administration/Group/{id}PUT/api/userstore/v2/{userstore}/administration/Group/{groupId}/usersPOST/api/userstore/v2/{userstore}/administration/Group/{groupId}/usersDELETE/api/userstore/v2/{userstore}/administration/Group/{groupId}/usersPUT/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroupsPOST/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroupsDELETE/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroupsPUT/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroupsPOST/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroupsDELETE/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroupsGET/api/userstore/v2/{userstore}/administration/Group/parentGroup/{parentGroupId}/membershipGET/api/userstore/v2/{userstore}/administration/Group/user/{userid}/membershipPOST/api/userstore/v2/{userstore}/administration/Group/synchronize
GetGroups
GET
/api/userstore/v2/{userstore}/administration/Group
Responses
OK
application/json
JSON { "instanceId": "string", "id": "string", "name": "string", "memberUsers": [...], "parentGroups": [...], "memberGroups": [...], "concurrencyToken": "string" }
[
]
CreateGroup
POST
/api/userstore/v2/{userstore}/administration/Group
Request Body
JSON "id": "string", "name": "string", "instanceId": "string"
{
}
Responses
Created
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
UpdateGroups
CreateGroupBatch
DeleteGroupBatch
GetGroup
GET
/api/userstore/v2/{userstore}/administration/Group/{id}
Responses
OK
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
UpdateGroup
PUT
/api/userstore/v2/{userstore}/administration/Group/{id}
Request Body
JSON "id": "string", "name": "string", "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
PatchGroup
PATCH
/api/userstore/v2/{userstore}/administration/Group/{id}
Request Body
JSON "name": null, "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
SetGroupMemberUsers
PUT
/api/userstore/v2/{userstore}/administration/Group/{groupId}/users
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
AddGroupUserToGroup
POST
/api/userstore/v2/{userstore}/administration/Group/{groupId}/users
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
RemoveGroupUserFromGroup
DELETE
/api/userstore/v2/{userstore}/administration/Group/{groupId}/users
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
SetGroupParentGroups
PUT
/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
AddParentGroup
POST
/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
RemoveParentGroup
DELETE
/api/userstore/v2/{userstore}/administration/Group/{groupId}/parentgroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
SetGroupMemberGroups
PUT
/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
AddMemberGroup
POST
/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
RemoveMemberGroup
DELETE
/api/userstore/v2/{userstore}/administration/Group/{groupId}/membergroups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "name": "string", "memberUsers": [ {...} ], "parentGroups": [ ], "memberGroups": [ ], "concurrencyToken": "string"
{
}
GetAllGroupMembershipFromGroup
GET
/api/userstore/v2/{userstore}/administration/Group/parentGroup/{parentGroupId}/membership
Responses
OK
application/json
JSON
[
]
GetAllGroupMembershipFromUser
GET
/api/userstore/v2/{userstore}/administration/Group/user/{userid}/membership
Responses
OK
application/json
JSON
[
]
SynchronizeAllGroups
POST
/api/userstore/v2/{userstore}/administration/Group/synchronize
Responses
OK
application/json
GroupMetadata
Operations
GET/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/groupIdGET/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}PUT/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}DELETE/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}PATCH/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}GET/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadataPOST/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata
GetGroupMetadataByGroupId
GET
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/groupId
Responses
OK
application/json
JSON { "instanceId": "string", "groupId": "string", "key": "string", "value": "string", "concurrencyToken": "string" }
[
]
GetGroupMetadata
GET
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}
Responses
OK
application/json
JSON "instanceId": "string", "groupId": "string", "key": "string", "value": "string", "concurrencyToken": "string"
{
}
UpdateGroupMetadata
DeleteGroupMetadata
DELETE
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}
Responses
No Content
PatchGroupMetadata
PATCH
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata/{key}
Request Body
JSON "groupId": "string", "key": "string", "value": "string", "instanceId": "string"
{
}
Responses
OK
application/json
JSON "instanceId": "string", "groupId": "string", "key": "string", "value": "string", "concurrencyToken": "string"
{
}
GetGroupMetadatas
GET
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata
Responses
OK
application/json
JSON
[
]
CreateGroupMetadata
POST
/api/userstore/v2/{userstore}/administration/Group/{groupId}/GroupMetadata
Request Body
JSON "groupId": "string", "key": "string", "value": "string", "instanceId": "string"
{
}
Responses
OK
application/json
JSON "instanceId": "string", "groupId": "string", "key": "string", "value": "string", "concurrencyToken": "string"
{
}
GetPasskeyCredentialsByUserId
GET
/api/userstore/v2/{userstore}/administration/PasskeyCredential/user/{userId}
Responses
OK
application/json
JSON { "id": "string", "userId": "string", "name": "string", "credentialIdBase64": "string", "isBackupEligible": true, "isBackedUp": true, "aaguidHex": "string", "createdOn": "string", "lastUsedOn": "string", "instanceId": "string" }
[
]
DeletePasskeyCredential
DELETE
/api/userstore/v2/{userstore}/administration/PasskeyCredential/user/{userId}/{passkeyId}
Responses
No Content
User
Operations
GET/api/userstore/v2/{userstore}/administration/User/{id}PUT/api/userstore/v2/{userstore}/administration/User/{id}DELETE/api/userstore/v2/{userstore}/administration/User/{id}PATCH/api/userstore/v2/{userstore}/administration/User/{id}GET/api/userstore/v2/{userstore}/administration/UserPOST/api/userstore/v2/{userstore}/administration/UserPUT/api/userstore/v2/{userstore}/administration/User/batchPOST/api/userstore/v2/{userstore}/administration/User/batchDELETE/api/userstore/v2/{userstore}/administration/User/batchPUT/api/userstore/v2/{userstore}/administration/User/{userId}/emailaddressPUT/api/userstore/v2/{userstore}/administration/User/{userId}/groupsPOST/api/userstore/v2/{userstore}/administration/User/{userId}/groupsDELETE/api/userstore/v2/{userstore}/administration/User/{userId}/groupsGET/api/userstore/v2/{userstore}/administration/User/{userId}/imagePUT/api/userstore/v2/{userstore}/administration/User/{userId}/imageDELETE/api/userstore/v2/{userstore}/administration/User/{userId}/imageGET/api/userstore/v2/{userstore}/administration/User/loginname/{userName}POST/api/userstore/v2/{userstore}/administration/User/synchronizePOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/initialPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/initial/resetPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/resetPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/reset/sendresetemailPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/reset/requestPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/reset/responsePOST/api/userstore/v2/{userstore}/administration/User/{userId}/lockout/resetPOST/api/userstore/v2/{userstore}/administration/User/{userId}/password/changePOST/api/userstore/v2/{userstore}/administration/User/{userId}/state
GetUser
GET
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
UpdateUser
PUT
/api/userstore/v2/{userstore}/administration/User/{id}
Request Body
JSON "id": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "userValidFrom": "string", "userValidTo": "string", "isUserActive": true, "isUserLockEnabled": true, "passwordNeverExpires": true, "canChangePasswordOnExpiration": true, "passwordExpiration": "string", "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
PatchUser
PATCH
/api/userstore/v2/{userstore}/administration/User/{id}
Request Body
JSON "loginName": null, "firstName": null, "lastName": null, "emailAddress": null, "emailAddressConfirmed": null, "phoneNumber": null, "phoneNumberConfirmed": null, "middleName": null, "nickname": null, "profile": null, "picture": null, "website": null, "gender": null, "birthdate": null, "zoneinfo": null, "locale": null, "userValidFrom": null, "userValidTo": null, "isUserActive": null, "isUserLockEnabled": null, "passwordNeverExpires": null, "canChangePasswordOnExpiration": null, "passwordExpiration": null, "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
GetUsers
GET
/api/userstore/v2/{userstore}/administration/User
Responses
OK
application/json
JSON { "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [...], "concurrencyToken": "string" }
[
]
CreateUser
POST
/api/userstore/v2/{userstore}/administration/User
Request Body
JSON "id": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "userValidFrom": "string", "userValidTo": "string", "isUserActive": true, "isUserLockEnabled": true, "passwordNeverExpires": true, "canChangePasswordOnExpiration": true, "passwordExpiration": "string", "instanceId": "string"
{
}
Responses
Created
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
UpdateUsers
PUT
/api/userstore/v2/{userstore}/administration/User/batch
Request Body
JSON { "id": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "userValidFrom": "string", "userValidTo": "string", "isUserActive": true, "isUserLockEnabled": true, "passwordNeverExpires": true, "canChangePasswordOnExpiration": true, "passwordExpiration": "string", "concurrencyToken": "string" }
[
]
Responses
OK
application/json
JSON
[
]
CreateBatch
POST
/api/userstore/v2/{userstore}/administration/User/batch
Request Body
JSON { "id": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "userValidFrom": "string", "userValidTo": "string", "isUserActive": true, "isUserLockEnabled": true, "passwordNeverExpires": true, "canChangePasswordOnExpiration": true, "passwordExpiration": "string", "instanceId": "string" }
[
]
Responses
OK
application/json
JSON
[
]
DeleteBatch
UpdateUserEmailAddress
PUT
/api/userstore/v2/{userstore}/administration/User/{userId}/emailaddress
Request Body
JSON "emailAddress": "string", "emailAddressConfirmed": true, "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
SetUserMemberOfGroups
PUT
/api/userstore/v2/{userstore}/administration/User/{userId}/groups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
AddUserToGroup
POST
/api/userstore/v2/{userstore}/administration/User/{userId}/groups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
RemoveUserFromGroup
DELETE
/api/userstore/v2/{userstore}/administration/User/{userId}/groups
Request Body
JSON "relatedIds": [ "string" ]
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
GetUserImage
GET
/api/userstore/v2/{userstore}/administration/User/{userId}/image
Responses
OK
application/json
JSON "id": "string", "userId": "string", "contentType": "string", "sizeBytes": 0, "sha256": "string", "concurrencyToken": "string"
{
}
SetUserImage
PUT
/api/userstore/v2/{userstore}/administration/User/{userId}/image
Responses
OK
application/json
JSON "id": "string", "userId": "string", "contentType": "string", "sizeBytes": 0, "sha256": "string", "concurrencyToken": "string"
{
}
DeleteUserImage
DELETE
/api/userstore/v2/{userstore}/administration/User/{userId}/image
Responses
No Content
GetUserByLoginName
GET
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
SynchronizeAllUsers
POST
/api/userstore/v2/{userstore}/administration/User/synchronize
Responses
OK
application/json
SetInitialPassword
POST
/api/userstore/v2/{userstore}/administration/User/{userId}/password/initial
Request Body
JSON "password": "string", "passwordExpiration": "string"
{
}
Responses
OK
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ResetInitialPasswordExpiration
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ResetPassword
POST
/api/userstore/v2/{userstore}/administration/User/{userId}/password/reset
Request Body
JSON "newPassword": "string"
{
}
Responses
OK
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
SendPasswordResetEmail
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ResetPasswordTokenRequest
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ResetPasswordTokenResponse
POST
/api/userstore/v2/{userstore}/administration/User/{userId}/password/reset/response
Request Body
JSON "token": "string", "newPassword": "string"
{
}
Responses
OK
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ResetAccessFailedCount
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
ChangePassword
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
SetUserState
POST
/api/userstore/v2/{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, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
UserProfile
Operations
GET/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfilePOST/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfileGET/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}PUT/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}DELETE/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}
GetUserProfiles
GET
/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile
Responses
OK
application/json
JSON { "instanceId": "string", "userId": "string", "key": "string", "value": "string", "concurrencyToken": "string" }
[
]
CreateUserProfile
POST
/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile
Request Body
JSON "userId": "string", "key": "string", "value": "string", "instanceId": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
GetUserProfile
GET
/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}
Responses
OK
application/json
JSON "instanceId": "string", "userId": "string", "key": "string", "value": "string", "concurrencyToken": "string"
{
}
UpdateUserProfile
PUT
/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}
Request Body
JSON "value": "string", "concurrencyToken": "string"
{
}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}
DeleteUserProfile
DELETE
/api/userstore/v2/{userstore}/administration/user/{parentId}/UserProfile/{key}
Responses
Accepted
application/json
JSON "instanceId": "string", "id": "string", "externalUniqueIdentifier": "string", "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "emailAddressConfirmed": true, "phoneNumber": "string", "phoneNumberConfirmed": true, "middleName": "string", "nickname": "string", "profile": "string", "picture": "string", "website": "string", "gender": "string", "birthdate": "string", "zoneinfo": "string", "locale": "string", "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": [ {...} ], "concurrencyToken": "string"
{
}