OrganizationApi
Last updated
Last updated
You need the scope to access this API.
For ease of use we recommend using the object for interaction instead.
RoleReference
MembershipInfo
OrganizationCreateDetails
OrganizationUpdateDetails
OrganizationInfo
OrganizationMembershipReference
constructor(user, endpoint)
Create an Organization API object.
endpoint
should be the Vulos Identity endpoint.
async organizationList()
Get a list of all the organizations that the user is in.
async organizationInfo(id)
Get information of an organization by the organization's ID.
async organizationUpdate(id, details)
Update an organization's details.
async organizationDelete(id)
Delete an organization.
async organizationCreate(details)
Create a new organization.
async memberInfo(id, member)
Get information about a specific member.
id
is the organization id;
member
is the membership id;
async memberDelete(id, member)
Remove a member from an organization.
async memberInvite(id, email)
Invite a user to an organization by email.
async roleList(id, member)
Get all the roles for a member.
async roleCreate(id, member, name)
Add a new role to a user.
async roleDelete(id, member, role)
Remove a role from a member.
role
is the role id;
user
should be an instance of the object.
The result is an array of objects that implement the .
This method's response has the organization:list
prefix.
The result implements the interface.
This method's response has the organization:info
prefix.
The details
object implements the interface.
The result implements the interface.
This method's response has the organization:update
prefix.
The result implements the interface.
This method's response has the organization:delete
prefix.
The details
object implements the interface.
The result implements the interface.
This method's response has the organization:create
prefix.
The result implements the interface.
This method's response has the organization:member:info
prefix.
The result implements the interface.
This method's response has the organization:member:delete
prefix.
The result implements the interface.
This method's response has the organization:member:invite
prefix.
The result is an array of objects that implement the interface.
This method's response has the organization:role:list
prefix.
The result implements the interface.
This method's response has the organization:role:create
prefix.
The result implements the interface.
This method's response has the organization:role:delete
prefix.