OrganizationRole

Members

api : OrganizationApi

The OrganizationAPI that this object was created with.

id : string

The id of this role.

name : string

The name of this role.

member : OrganizationMembership

The membership that this role is associated with.

Methods

constructor(api, member, role)

Create a new role object using the Organization API.

• api must be an instance of OrganizationApi;
• member must be an instance of OrganizationMembership;
• role must implement the RoleReference interface;

This constructor should not be called directly, use OrganizationMembership.getRoles() instead.

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
}