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

200: OK Information about the member

{
    "roles": [
        { "name": "SuperAdmin", "id": "<guid>" }
    ],
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "organizationId": 2,
    "membershipId": "<guid>"
    "userId": "<guid>"
}

400: Bad Request Error response

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

401: Unauthorized Empty body

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

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

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

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

Roles

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

Roles