Members
BASE URL:
https://api.umbraco.io
Api-Version: 2
Umb-Project-Alias: {project-alias}
Auth is required for this API meaning that you must supply a Bearer Token via an Authorization header or an API Key via an Authorization or Api-Key header.
If an error occours you will receive a HTTP status code along with an API error code and an error message in the response body.
Status Code | Error Code | Message |
---|---|---|
400 | BadRequest | Body cannot be empty. |
400 | CouldNotUnlockUser | Could not unlock the user. |
401 | Unauthorized | Authorization has been denied for this request. |
403 | Forbidden | You are not authorized to access the given resource. |
404 | NotFound | Member with username '{username}' could not be found. |
422 | ValidationFailed | Validation error occured when trying to save or update the member. |
500 | InternalServerError | Internal server error. |
JSON example:
{
"error": {
"code": "Unauthorized",
"message": "Authorization has been denied for this request."
}
}
Get a specific member by their username.
URL:
/member/{username}
Method:
GET
Permissions required : Access to Member section of the Umbraco Backoffice
Code: 200
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [
"Club Blue Members"
],
"_lastLoginDate": "2019-10-10T12:04:24Z",
"_lastPasswordChangeDate": "2019-10-10T12:04:24Z",
"_createDate": "2019-10-10T12:04:24.203Z",
"_id": "153c22ad-2940-4d1c-9253-f62a2a873915",
"_updateDate": "2019-10-10T12:04:24.487Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/john%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "First Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "John Doe"
}
Create a new member.
To set a password when creating a member a
password
field must be included in the posted data. If the password field is omitted no password will be set.URL:
/member/
Method:
POST
Permissions required : Access to Member section of the Umbraco Backoffice
{
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane Doe"
}
Code: 201
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [],
"_createDate": "2019-10-10T12:18:06.6087436Z",
"_id": "fbabbae4-738d-406a-a7b6-e6684a622882",
"_updateDate": "2019-10-10T12:18:06.6087436Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/john%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane Doe"
}
Update an existing member.
A member can be unlocked by setting
isLockedOut
to false
in the request, note that a member cannot be locked by setting the value to true
, it will be ignored if the user is not already locked out .URL:
/member/{username}
Method:
PUT
Permissions required : Access to Member section of the Umbraco Backoffice
{
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane A. Doe"
}
Code: 200
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [],
"_createDate": "2019-10-10T12:19:57.053Z",
"_id": "59c97163-0ece-4b92-893a-d3da4af2c888",
"_updateDate": "2019-10-10T12:20:30.1886381Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/jane%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane A. Doe"
}
Delete an existing member by their username.
URL:
/member/{username}
Method:
DELETE
Permissions required : Access to Member section of the Umbraco Backoffice
Code: 200
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [],
"_lastLoginDate": "2019-10-10T12:04:24Z",
"_lastPasswordChangeDate": "2019-10-10T12:04:24Z",
"_createDate": "2019-10-10T12:04:24.203Z",
"_id": "153c22ad-2940-4d1c-9253-f62a2a873915",
"_updateDate": "2019-10-10T12:04:24.487Z",
"_deleteDate": "2019-10-10T12:16:41.2371252Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/john%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "First Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "John Doe"
}
Change a members password.
URL:
/member/{username}/password
Method:
POST
Permissions required : Access to Member section of the Umbraco Backoffice
{
"currentPassword": "<current password>",
"newPassword": "<new password>"
}
Code: 200
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [],
"_createDate": "2019-10-10T12:19:57.053Z",
"_id": "59c97163-0ece-4b92-893a-d3da4af2c888",
"_updateDate": "2019-10-10T12:20:30.1886381Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/jane%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane A. Doe"
}
Get a reset password token.
URL:
/member/{username}/password/reset-token
Method:
GET
Permissions required : Access to Member section of the Umbraco Backoffice
Code: 200
Content Example:
{
"token": "ydAcKSmv+zAdPqFeYPuBAGojmFvJeiI2B6K79x0eOGX5EMevdu/vs16eq5sZ85crk2V+/7JmxN6s/5MJFvNg2K9Iex3cFmNlI8uTmvw2HuQzCr3Zo9KyKh19Gy4iTfzx+Q3Q0z1TCuSdBxjpiI6nuQ==",
"expires_in": 86399,
"_links": {
"self": {
"href": "/api/member/jane%40example.com/password/reset-token"
},
"member": {
"href": "/api/member/jane%40example.com"
}
},
"_embedded": {
"member": {
"_failedPasswordAttempts": 0,
"_groups": [],
"_createDate": "2019-10-10T12:19:57.053Z",
"_id": "59c97163-0ece-4b92-893a-d3da4af2c888",
"_updateDate": "2019-10-10T12:20:30.1886381Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/jane%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane A. Doe"
}
}
Reset a members password.
URL:
/member/{username}/password/reset
Method:
POST
Permissions required : Access to Member section of the Umbraco Backoffice
{
"token": "ydAcKSmv+zAdPqFeYPuBAGojmFvJeiI2B6K79x0eOGX5EMevdu/vs16eq5sZ85crk2V+/7JmxN6s/5MJFvNg2K9Iex3cFmNlI8uTmvw2HuQzCr3Zo9KyKh19Gy4iTfzx+Q3Q0z1TCuSdBxjpiI6nuQ==",
"newPassword": "<new password>"
}
Code: 200
Content Example:
{
"_failedPasswordAttempts": 0,
"_groups": [],
"_createDate": "2019-10-10T12:18:06.6087436Z",
"_id": "fbabbae4-738d-406a-a7b6-e6684a622882",
"_updateDate": "2019-10-10T12:18:06.6087436Z",
"_links": {
"self": {
"href": "https://api.umbraco.io/member/john%40example.com"
},
"membertype": {
"href": "https://api.umbraco.io/member/type/Member"
}
},
"comments": "A Valued Club Blue Member",
"email": "[email protected]",
"isApproved": true,
"isLockedOut": false,
"memberTypeAlias": "Member",
"username": "[email protected]",
"name": "Jane Doe"
}
Add an existing member to an existing member group.
URL:
/member/{username}/groups/{groupName}
Method:
PUT
Permissions required : Access to Member section of the Umbraco Backoffice
Code: 200
Remove a specific member from a specific member group.
URL:
/member/{username}/groups/{groupName}
Method:
DELETE
Permissions required : Access to Member section of the Umbraco Backoffice
Code: 200
Last modified 3mo ago