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
  • Membership Info
  • Invite Member
  • Delete Membership
  • Roles
  1. Reference
  2. Organization API

Memberships

Using these endpoints you can invite, manage and delete members.

Membership Info

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

Get information about 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

{
    "roles": [
        { "name": "SuperAdmin", "id": "<guid>" }
    ],
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "organizationId": 2,
    "membershipId": "<guid>"
    "userId": "<guid>"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

Invite Member

PUT https://identity.vulos.io/api/v1/organization/:organizationId/invite/:email

Invite a new member to an organization using their email address.

Path Parameters

Name
Type
Description

organizationId*

String

The ID of the organization

email*

String

The email of the member that will get invited

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>"
}

Delete Membership

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

Delete a membership from an organization.

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

{
     "success": true,
     "message": "A message describing the successful response"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

Roles

If you want to update, delete and see the roles in a membership, you can use the following endpoints:

PreviousOrganizationsNextRoles

Last updated 3 years ago

Roles