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
  • Members
  • api : OrganizationApi
  • id : string
  • name : string
  • member : OrganizationMembership
  • Methods
  • constructor(api, member, role)
  • async remove()
  1. Reference
  2. Identity JavaScript SDK
  3. The Base Package
  4. Organizations

OrganizationRole

PreviousOrganizationMembershipWithMetadataNextOrganizationApi

Last updated 3 years ago

Members

api :

The OrganizationAPI that this object was created with.

id : string

The id of this role.

name : string

The name of this role.

member :

The membership that this role is associated with.

Methods

constructor(api, member, role)

Create a new role object using the .

async remove()

Remove this role from the membership.

The result is a boolean that indicates success.

if (await role.remove()) {
    // the role was successfully removed from the membership
}

api must be an instance of ;

member must be an instance of ;

role must implement the interface;

This constructor should not be called directly, use instead.

OrganizationApi
OrganizationMembership
Organization API
OrganizationApi
OrganizationMembership
RoleReference
OrganizationMembership.getRoles()