API Reference
- GETGet Active Organisation
- GETGet Organisations
- POSTCreate Organisation
- GETGet Organisation
- GETGet Members
- GETGet Member
- DELDelete Member
- GETGet Service Accounts
- POSTCreate Service Account
- GETGet Service Account
- DELDelete Service Account
- GETGet Groups
- POSTCreate Group
- GETGet Group
- DELDelete Group
- GETGet Invitations
- POSTInvite Member
- DELDelete Invitation
- PUTAccept Invitation
- PUTResend Invitation
- PUTSet Active Organisation
- GETGet Billing
- PUTUpdate Billing Details such as billing email
- GETGet Invoices
- PUTUpdate Subscription
- POSTCreate Checkout Session
- GETGet Slug Availability
- GET
curl --request GET \
--url https://platform.versori.com/api/organisations/v1/organisations/{organisation_id}/members/{member_id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identityType": "user",
"identityId": "<string>",
"name": "<string>",
"email": "<string>",
"picture": "<string>",
"roleBindings": [
{
"role": {
"id": "<string>",
"name": "<string>",
"permissions": [
{
"id": "organisation.read",
"description": "<string>"
}
],
"scopes": [
"organisation"
]
},
"resource": {
"resourceType": "organisation",
"resourceId": "<string>",
"name": "<string>"
}
}
]
}Get Member
GetMember returns a member for the given Organisation.
curl --request GET \
--url https://platform.versori.com/api/organisations/v1/organisations/{organisation_id}/members/{member_id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identityType": "user",
"identityId": "<string>",
"name": "<string>",
"email": "<string>",
"picture": "<string>",
"roleBindings": [
{
"role": {
"id": "<string>",
"name": "<string>",
"permissions": [
{
"id": "organisation.read",
"description": "<string>"
}
],
"scopes": [
"organisation"
]
},
"resource": {
"resourceType": "organisation",
"resourceId": "<string>",
"name": "<string>"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
Member is an identity who is a member of an Organisation.
ID is the unique identifier for the Member, if a user is a member of multiple Organisations they will have multiple Member objects.
user, service_account IdentityID references the Versori User.
Name is either the User's name or ServiceAccount's name. If name is not populated this will default to the email address.
Email is the email address of the Member. For service accounts this is the service account name with the suffix @sa.ORG_SLUG.versori.com.
RoleBindings are the list of roles bindings granted to this Member.
Show child attributes
Show child attributes
Role encompasses a set of permissions which can be granted to a Member or Group. Roles are currently predefined but may support custom roles in the future.
Show child attributes
Show child attributes
Name is the user-defined name for the role. It must be unique within the scope of an Organisation.
Show child attributes
Show child attributes
ID is a human-readable identifier for the permission, i.e. switchboard.publish
organisation.read, organisation.edit, organisation.delete, organisation.members.read, organisation.members.invite, organisation.members.edit, organisation.members.delete, organisation.manage_billing, organisation.manage_subscription, switchboard.create, switchboard.read, switchboard.edit, switchboard.publish, switchboard.delete, connection.create, connection.read, connection.edit, connection.delete, hub.create, hub.read, hub.edit, hub.delete, hub.integration.create, hub.integration.read, hub.integration.edit, hub.integration.publish, hub.integration.delete, hub.user.create, hub.user.read, hub.user.edit, hub.user.delete Description is a human-readable description of what the permission grants
Scope defines which resources the role can be bound to, i.e. "organisation", "switchboard" etc. Resources are hierarchical, meaning that if a role is bound to an Organisation, it will be inherited by all resources owned by that organisation, whereas if it is bound to an individual child resource such as a Switchboard board, it will only apply to that board.
organisation, switchboard, connection, hub