1 of 3

Members

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get by username
Create Member
Update Member
Delete Member
Change Member Password
Get a reset member password token
Reset member password
Add member to member group
Remove member from member group

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

Authentication is required for this API. You must supply a Bearer Token via an Authorization header or an API Key through an Authorization or Api-Key header.

Errors

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.

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get by username

Get a specific member by their username.

URL: /member/{username}

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "john@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "john@example.com",
    "name": "John Doe"
}

Create member

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

Request

{
    "comments": "A Valued Club Blue Member",
    "email": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Update member

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

Request

{
    "comments": "A Valued Club Blue Member",
    "email": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Delete member

Delete an existing member by their username.

URL: /member/{username}

Method: DELETE

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "john@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "john@example.com",
    "name": "John Doe"
}

Change member password

Change a members password.

URL: /member/{username}/password

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
    "currentPassword": "<current password>",
    "newPassword": "<new password>"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Get a reset member password token

Get a reset password token.

URL: /member/{username}/password/reset-token

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "jane@example.com",
        "isApproved": true,
        "isLockedOut": false,
        "memberTypeAlias": "Member",
        "username": "jane@example.com",
        "name": "Jane A. Doe"
    }
}

Reset member password

Reset a members password.

URL: /member/{username}/password/reset

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
    "token": "ydAcKSmv+zAdPqFeYPuBAGojmFvJeiI2B6K79x0eOGX5EMevdu/vs16eq5sZ85crk2V+/7JmxN6s/5MJFvNg2K9Iex3cFmNlI8uTmvw2HuQzCr3Zo9KyKh19Gy4iTfzx+Q3Q0z1TCuSdBxjpiI6nuQ==",
    "newPassword": "<new password>"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Add member to member group

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

Success Response

Code: 200

Remove member from member group

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

Success Response

Code: 200

Member Groups

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get All
Get By Name
Create member group
Delete member group

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

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.

Errors

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.

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get all

Get all Member Groups.

URL: /member/group

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
  "_links": {
    "self": {
      "href": "/api/member/group"
    },
    "membergroups": {
      "href": "/api/member/group/Club%20Blue%20Members",
      "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  },
  "_embedded": {
    "membergroups": [
      {
        "name": "Club Blue Members",
        "_createDate": "2019-10-10T12:02:50.83Z",
        "_id": "15a1a854-596c-4b72-b462-769015a6b0eb",
        "_updateDate": "0001-01-01T00:00:00Z",
        "_links": {
          "self": {
            "href": "/api/member/group/Club%20Blue%20Members"
          }
        }
      },
      {
        "name": "Elite Shoppers Group",
        "_createDate": "2019-10-10T12:09:58.5982624Z",
        "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
        "_updateDate": "0001-01-01T00:00:00Z",
        "_links": {
          "self": {
            "href": "/api/member/group/Elite%20Shoppers%20Group"
          }
        }
      }
    ]
  }
}

Get by name

Get a specific Member Group by its name.

URL: /member/group/{name}

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
  "name": "Club Blue Members",
  "_createDate": "2019-10-10T12:02:50.83Z",
  "_id": "15a1a854-596c-4b72-b462-769015a6b0eb",
  "_updateDate": "0001-01-01T00:00:00Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Club%20Blue%20Members"
    }
  }
}

Create member group

Create a new Member Group.

URL: /member/group

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
  "name": "Elite Shoppers Group"
}

Success Response

Code: 201

Content Example:

{
  "name": "Elite Shoppers Group",
  "_createDate": "2019-10-10T12:09:58.5982624Z",
  "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
  "_updateDate": "2019-10-10T12:09:58.5982624Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  }
}

Delete member group

Delete an existing Member Group.

URL: /member/group/{name}

Method: DELETE

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

DELETE https://api.umbraco.io/member/group/Elite%20Shoppers%20Group

{
  "name": "Elite Shoppers Group",
  "_createDate": "2019-10-10T12:09:58.597Z",
  "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
  "_updateDate": "0001-01-01T00:00:00Z",
  "_deleteDate": "2019-10-10T12:10:45.0657415Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  }
}

Member Types

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get all member types
Get by alias

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

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.

Errors

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.

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get all member types

Get a list of all available member types.

URL: /member/type

Method: GET

Permissions required : Access to Settings section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
    "_links": {
        "self": {
            "href": "https://api.umbraco.io/member/type"
        },
        "membertypes": [
            {
                "href": "https://api.umbraco.io/member/type/Member"
            },
            {
                "href": "https://api.umbraco.io/member/type/shopMembers"
            }
        ]
    },
    "_embedded": {
        "membertypes": [
            {
                "alias": "Member",
                "compositions": [],
                "groups": [
                    {
                        "name": "Membership",
                        "sortOrder": 1,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberComments",
                                "label": "Comments",
                                "propertyEditorAlias": "Umbraco.TextArea",
                                "sortOrder": 0,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberFailedPasswordAttempts",
                                "label": "Failed Password Attempts",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 1,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberApproved",
                                "label": "Is Approved",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 2,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLockedOut",
                                "label": "Is Locked Out",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 3,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLockoutDate",
                                "label": "Last Lockout Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 4,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLogin",
                                "label": "Last Login Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 5,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastPasswordChangeDate",
                                "label": "Last Password Change Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 6,
                                "validation": {
                                    "required": false
                                }
                            }
                        ]
                    }
                ],
                "name": "Member",
                "_createDate": "2019-09-20T12:07:43.987Z",
                "_id": "d59be02f-1df9-4228-aa1e-01917d806cda",
                "_updateDate": "2019-09-20T12:07:43.987Z",
                "_links": {
                    "self": {
                        "href": "https://api.umbraco.io/member/type/Member"
                    },
                    "root": {
                        "href": "https://api.umbraco.io/member/type"
                    }
                }
            },
            {
                "alias": "shopMembers",
                "compositions": [],
                "groups": [
                    {
                        "name": "Shop Details",
                        "sortOrder": 0,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": true,
                                "alias": "favouriteProduct",
                                "label": "Favourite Product",
                                "propertyEditorAlias": "Umbraco.TextBox",
                                "sortOrder": 0,
                                "validation": {
                                    "required": true
                                }
                            }
                        ]
                    },
                    {
                        "name": "Membership",
                        "sortOrder": 1,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberComments",
                                "label": "Comments",
                                "propertyEditorAlias": "Umbraco.TextArea",
                                "sortOrder": 0,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberFailedPasswordAttempts",
                                "label": "Failed Password Attempts",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 1,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberApproved",
                                "label": "Is Approved",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 2,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLockedOut",
                                "label": "Is Locked Out",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 3,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLockoutDate",
                                "label": "Last Lockout Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 4,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLogin",
                                "label": "Last Login Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 5,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastPasswordChangeDate",
                                "label": "Last Password Change Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 6,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberPasswordRetrievalAnswer",
                                "label": "Password Answer",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 7,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberPasswordRetrievalQuestion",
                                "label": "Password Question",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 8,
                                "validation": {
                                    "required": false
                                }
                            }
                        ]
                    }
                ],
                "name": "Shop Members",
                "_createDate": "2019-10-10T12:07:17.37Z",
                "_id": "ff345c85-dd87-49f2-a1de-ab7a23e54aea",
                "_updateDate": "2019-10-10T12:07:17.37Z",
                "_links": {
                    "self": {
                        "href": "https://api.umbraco.io/member/type/shopMembers"
                    },
                    "root": {
                        "href": "https://api.umbraco.io/member/type"
                    }
                }
            }
        ]
    }
}

Get by alias

Get a specific member type by its alias.

URL: /member/type/{alias}

Method: GET

Permissions required : Access to Settings section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
    "alias": "Member",
    "compositions": [],
    "groups": [
        {
            "name": "Membership",
            "sortOrder": 1,
            "properties": [
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberComments",
                    "label": "Comments",
                    "propertyEditorAlias": "Umbraco.TextArea",
                    "sortOrder": 0,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberFailedPasswordAttempts",
                    "label": "Failed Password Attempts",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 1,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberApproved",
                    "label": "Is Approved",
                    "propertyEditorAlias": "Umbraco.TrueFalse",
                    "sortOrder": 2,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLockedOut",
                    "label": "Is Locked Out",
                    "propertyEditorAlias": "Umbraco.TrueFalse",
                    "sortOrder": 3,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastLockoutDate",
                    "label": "Last Lockout Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 4,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastLogin",
                    "label": "Last Login Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 5,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastPasswordChangeDate",
                    "label": "Last Password Change Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 6,
                    "validation": {
                        "required": false
                    }
                }
            ]
        }
    ],
    "name": "Member",
    "_createDate": "2019-09-20T12:07:43.987Z",
    "_id": "d59be02f-1df9-4228-aa1e-01917d806cda",
    "_updateDate": "2019-09-20T12:07:43.987Z",
    "_links": {
        "self": {
            "href": "https://api.umbraco.io/member/type/Member"
        },
        "root": {
            "href": "https://api.umbraco.io/member/type"
        }
    }
}

Member Groups

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get All
Get By Name
Create member group
Delete member group

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

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.

Errors

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

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get all

Get all Member Groups.

URL: /member/group

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
  "_links": {
    "self": {
      "href": "/api/member/group"
    },
    "membergroups": {
      "href": "/api/member/group/Club%20Blue%20Members",
      "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  },
  "_embedded": {
    "membergroups": [
      {
        "name": "Club Blue Members",
        "_createDate": "2019-10-10T12:02:50.83Z",
        "_id": "15a1a854-596c-4b72-b462-769015a6b0eb",
        "_updateDate": "0001-01-01T00:00:00Z",
        "_links": {
          "self": {
            "href": "/api/member/group/Club%20Blue%20Members"
          }
        }
      },
      {
        "name": "Elite Shoppers Group",
        "_createDate": "2019-10-10T12:09:58.5982624Z",
        "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
        "_updateDate": "0001-01-01T00:00:00Z",
        "_links": {
          "self": {
            "href": "/api/member/group/Elite%20Shoppers%20Group"
          }
        }
      }
    ]
  }
}

Get by name

Get a specific Member Group by its name.

URL: /member/group/{name}

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
  "name": "Club Blue Members",
  "_createDate": "2019-10-10T12:02:50.83Z",
  "_id": "15a1a854-596c-4b72-b462-769015a6b0eb",
  "_updateDate": "0001-01-01T00:00:00Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Club%20Blue%20Members"
    }
  }
}

Create member group

Create a new Member Group.

URL: /member/group

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
  "name": "Elite Shoppers Group"
}

Success Response

Code: 201

Content Example:

{
  "name": "Elite Shoppers Group",
  "_createDate": "2019-10-10T12:09:58.5982624Z",
  "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
  "_updateDate": "2019-10-10T12:09:58.5982624Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  }
}

Delete member group

Delete an existing Member Group.

URL: /member/group/{name}

Method: DELETE

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

DELETE https://api.umbraco.io/member/group/Elite%20Shoppers%20Group

{
  "name": "Elite Shoppers Group",
  "_createDate": "2019-10-10T12:09:58.597Z",
  "_id": "1ae62150-e54c-4fd7-aabe-9ad46d1b7109",
  "_updateDate": "0001-01-01T00:00:00Z",
  "_deleteDate": "2019-10-10T12:10:45.0657415Z",
  "_links": {
    "self": {
    "href": "/api/member/group/Elite%20Shoppers%20Group"
    }
  }
}

Member Types

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get all member types
Get by alias

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

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.

Errors

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

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get all member types

Get a list of all available member types.

URL: /member/type

Method: GET

Permissions required : Access to Settings section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
    "_links": {
        "self": {
            "href": "https://api.umbraco.io/member/type"
        },
        "membertypes": [
            {
                "href": "https://api.umbraco.io/member/type/Member"
            },
            {
                "href": "https://api.umbraco.io/member/type/shopMembers"
            }
        ]
    },
    "_embedded": {
        "membertypes": [
            {
                "alias": "Member",
                "compositions": [],
                "groups": [
                    {
                        "name": "Membership",
                        "sortOrder": 1,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberComments",
                                "label": "Comments",
                                "propertyEditorAlias": "Umbraco.TextArea",
                                "sortOrder": 0,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberFailedPasswordAttempts",
                                "label": "Failed Password Attempts",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 1,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberApproved",
                                "label": "Is Approved",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 2,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLockedOut",
                                "label": "Is Locked Out",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 3,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLockoutDate",
                                "label": "Last Lockout Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 4,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLogin",
                                "label": "Last Login Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 5,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastPasswordChangeDate",
                                "label": "Last Password Change Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 6,
                                "validation": {
                                    "required": false
                                }
                            }
                        ]
                    }
                ],
                "name": "Member",
                "_createDate": "2019-09-20T12:07:43.987Z",
                "_id": "d59be02f-1df9-4228-aa1e-01917d806cda",
                "_updateDate": "2019-09-20T12:07:43.987Z",
                "_links": {
                    "self": {
                        "href": "https://api.umbraco.io/member/type/Member"
                    },
                    "root": {
                        "href": "https://api.umbraco.io/member/type"
                    }
                }
            },
            {
                "alias": "shopMembers",
                "compositions": [],
                "groups": [
                    {
                        "name": "Shop Details",
                        "sortOrder": 0,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": true,
                                "alias": "favouriteProduct",
                                "label": "Favourite Product",
                                "propertyEditorAlias": "Umbraco.TextBox",
                                "sortOrder": 0,
                                "validation": {
                                    "required": true
                                }
                            }
                        ]
                    },
                    {
                        "name": "Membership",
                        "sortOrder": 1,
                        "properties": [
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberComments",
                                "label": "Comments",
                                "propertyEditorAlias": "Umbraco.TextArea",
                                "sortOrder": 0,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberFailedPasswordAttempts",
                                "label": "Failed Password Attempts",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 1,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberApproved",
                                "label": "Is Approved",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 2,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLockedOut",
                                "label": "Is Locked Out",
                                "propertyEditorAlias": "Umbraco.TrueFalse",
                                "sortOrder": 3,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLockoutDate",
                                "label": "Last Lockout Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 4,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastLogin",
                                "label": "Last Login Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 5,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberLastPasswordChangeDate",
                                "label": "Last Password Change Date",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 6,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberPasswordRetrievalAnswer",
                                "label": "Password Answer",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 7,
                                "validation": {
                                    "required": false
                                }
                            },
                            {
                                "isSensitive": false,
                                "memberCanEdit": false,
                                "memberCanView": false,
                                "alias": "umbracoMemberPasswordRetrievalQuestion",
                                "label": "Password Question",
                                "propertyEditorAlias": "Umbraco.Label",
                                "sortOrder": 8,
                                "validation": {
                                    "required": false
                                }
                            }
                        ]
                    }
                ],
                "name": "Shop Members",
                "_createDate": "2019-10-10T12:07:17.37Z",
                "_id": "ff345c85-dd87-49f2-a1de-ab7a23e54aea",
                "_updateDate": "2019-10-10T12:07:17.37Z",
                "_links": {
                    "self": {
                        "href": "https://api.umbraco.io/member/type/shopMembers"
                    },
                    "root": {
                        "href": "https://api.umbraco.io/member/type"
                    }
                }
            }
        ]
    }
}

Get by alias

Get a specific member type by its alias.

URL: /member/type/{alias}

Method: GET

Permissions required : Access to Settings section of the Umbraco Backoffice

Success Response

Code: 200

Content Example:

{
    "alias": "Member",
    "compositions": [],
    "groups": [
        {
            "name": "Membership",
            "sortOrder": 1,
            "properties": [
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberComments",
                    "label": "Comments",
                    "propertyEditorAlias": "Umbraco.TextArea",
                    "sortOrder": 0,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberFailedPasswordAttempts",
                    "label": "Failed Password Attempts",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 1,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberApproved",
                    "label": "Is Approved",
                    "propertyEditorAlias": "Umbraco.TrueFalse",
                    "sortOrder": 2,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLockedOut",
                    "label": "Is Locked Out",
                    "propertyEditorAlias": "Umbraco.TrueFalse",
                    "sortOrder": 3,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastLockoutDate",
                    "label": "Last Lockout Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 4,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastLogin",
                    "label": "Last Login Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 5,
                    "validation": {
                        "required": false
                    }
                },
                {
                    "isSensitive": false,
                    "memberCanEdit": false,
                    "memberCanView": false,
                    "alias": "umbracoMemberLastPasswordChangeDate",
                    "label": "Last Password Change Date",
                    "propertyEditorAlias": "Umbraco.Label",
                    "sortOrder": 6,
                    "validation": {
                        "required": false
                    }
                }
            ]
        }
    ],
    "name": "Member",
    "_createDate": "2019-09-20T12:07:43.987Z",
    "_id": "d59be02f-1df9-4228-aa1e-01917d806cda",
    "_updateDate": "2019-09-20T12:07:43.987Z",
    "_links": {
        "self": {
            "href": "https://api.umbraco.io/member/type/Member"
        },
        "root": {
            "href": "https://api.umbraco.io/member/type"
        }
    }
}

Members

BASE URL: https://api.umbraco.io

Common Headers
Authentication
Errors
Get by username
Create Member
Update Member
Delete Member
Change Member Password
Get a reset member password token
Reset member password
Add member to member group
Remove member from member group

Common Headers

Api-Version: 2
Umb-Project-Alias: {project-alias}

Authentication

Authentication is required for this API. You must supply a Bearer Token via an Authorization header or an API Key through an Authorization or Api-Key header.

Errors

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

JSON example:

{
  "error": {
    "code": "Unauthorized",
    "message": "Authorization has been denied for this request."
  }
}

Get by username

Get a specific member by their username.

URL: /member/{username}

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "john@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "john@example.com",
    "name": "John Doe"
}

Create member

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

Request

{
    "comments": "A Valued Club Blue Member",
    "email": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Update member

Update an existing member.

URL: /member/{username}

Method: PUT

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
    "comments": "A Valued Club Blue Member",
    "email": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Delete member

Delete an existing member by their username.

URL: /member/{username}

Method: DELETE

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "john@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "john@example.com",
    "name": "John Doe"
}

Change member password

Change a members password.

URL: /member/{username}/password

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
    "currentPassword": "<current password>",
    "newPassword": "<new password>"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane A. Doe"
}

Get a reset member password token

Get a reset password token.

URL: /member/{username}/password/reset-token

Method: GET

Permissions required : Access to Member section of the Umbraco Backoffice

Success Response

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": "jane@example.com",
        "isApproved": true,
        "isLockedOut": false,
        "memberTypeAlias": "Member",
        "username": "jane@example.com",
        "name": "Jane A. Doe"
    }
}

Reset member password

Reset a members password.

URL: /member/{username}/password/reset

Method: POST

Permissions required : Access to Member section of the Umbraco Backoffice

Request

{
    "token": "ydAcKSmv+zAdPqFeYPuBAGojmFvJeiI2B6K79x0eOGX5EMevdu/vs16eq5sZ85crk2V+/7JmxN6s/5MJFvNg2K9Iex3cFmNlI8uTmvw2HuQzCr3Zo9KyKh19Gy4iTfzx+Q3Q0z1TCuSdBxjpiI6nuQ==",
    "newPassword": "<new password>"
}

Success Response

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": "jane@example.com",
    "isApproved": true,
    "isLockedOut": false,
    "memberTypeAlias": "Member",
    "username": "jane@example.com",
    "name": "Jane Doe"
}

Add member to member group

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

Success Response

Code: 200

Remove member from member group

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

Success Response

Code: 200

Members

Table of Contents

Common Headers

Authentication

Errors

Get by username

Success Response

Create member

Request

Success Response

Update member

Request

Success Response

Delete member

Success Response

Change member password

Request

Success Response

Get a reset member password token

Success Response

Reset member password

Request

Success Response

Add member to member group

Success Response

Remove member from member group

Success Response

Member Groups

Table of Contents

Common Headers

Authentication

Errors

Get all

Success Response

Get by name

Success Response

Create member group

Request

Success Response

Delete member group

Success Response

Member Types

Table of Contents

Common Headers

Authentication

Errors

Get all member types

Success Response

Get by alias

Success Response

Member Groups

Table of Contents

Common Headers

Authentication

Errors

Get all

Success Response

Get by name

Success Response

Create member group

Request

Success Response

Delete member group

Success Response

Member Types

Table of Contents

Common Headers

Authentication

Errors

Get all member types

Success Response

Get by alias

Success Response

Members

Table of Contents

Common Headers

Authentication

Errors

Get by username

Success Response