Roles

Using these endpoints you can list, create and delete roles in a membership.

Role List

GET https://identity.vulos.io/api/v1/organization/:organizationId/:membershipId/role/list

Get all of the roles in a specific membership.

Path Parameters

Name
Type
Description

organizationId*

String

The ID of the organization

membershipId*

String

The ID of the membership

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

[
    { "name": "SuperAdmin", "id": "<guid>" }
]

Create Role

PUT https://identity.vulos.io/api/v1/organization/:organizationId/:membershipId/role/create

Create a new role in a specific membership.

Path Parameters

Name
Type
Description

organizationId*

String

The ID of the organization

membershipId*

String

The ID of the membership

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

Request Body

Name
Type
Description

name*

String

The name of the role

{ "name": "SuperAdmin", "id": "<guid>" }

Delete Role

DELETE https://identity.vulos.io/api/v1/organization/:organizationId/:membershipId/role/:roleId/delete

Delete a specific role.

Path Parameters

Name
Type
Description

organizationId*

String

The ID of the organization

membershipId*

String

The ID of the membership

roleId*

String

The ID of the role

Headers

Name
Type
Description

Authorization*

String

Bearer authentication with the access token obtained using OpenID Connect

{
     "success": true,
     "message": "A message describing the successful response"
}
PreviousMembershipsNextProfile API

Last updated