Vulos Documentation
  • Identity
    • Welcome to the Vulos Identity Documentation!
    • Quick Start
    • Organizations
    • Scopes and Claims
  • Reference
    • Identity JavaScript SDK
      • The Base Package
        • KYC
          • KycStatus
          • KycInstance
          • KycDetails
          • KycApi
        • Profile
          • UserReference
          • ProfileApi
        • Cache
        • Authentication
          • Application
          • BaseAuth
          • User
          • UserInfo
          • BaseApi
        • Organizations
          • Organization
          • OrganizationMembership
            • OrganizationMembershipWithMetadata
          • OrganizationRole
          • OrganizationApi
      • The Backend Auth Package
        • CodeVerifier
        • BackendAuth
      • The Frontend Auth Package
        • IFrameRefresh
        • StateVerifier
        • FrontendAuth
    • Organization API
      • Organizations
      • Memberships
        • Roles
    • Profile API
    • KYC API
Powered by GitBook
On this page
  • Role List
  • Create Role
  • Delete Role
  1. Reference
  2. Organization API
  3. Memberships

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>" }
]
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

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>" }
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

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"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}
PreviousMembershipsNextProfile API

Last updated 3 years ago