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

200: OK All of the roles that are in the membership

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

400: Bad Request Error response

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

401: Unauthorized Empty body

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

200: OK The role that was created

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

400: Bad Request Error response

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

403: Forbidden Empty body

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

200: OK Success message

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

400: Bad Request Error response

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

401: Unauthorized Empty body