Users

List of users

This will get a list of the users belonging to an organization.

GET /api/v0/users

Required permissions for API key

  • Read

Response

{
  "users": [<user>, <user>, ...]
}

<user> is an object that holds the following keys

KEY TYPE DESCRIPTION
id string user ID
screenName string user account's display name
email string user's email address
authority string user's authority (owner, manager, collaborator, viewer)

Delete users

This will delete users belonging to an organization.

DELETE /api/v0/users/<userId>

Required permissions for API key

  • Read
  • Write

Response

Success

The information of the user that was deleted from the organization will be returned. The format will be the same as when getting the list of users.

Error

STATUS CODE DESCRIPTION
400 when the JSON format is incorrect
403 when the API doesn’t have the required permissions / when the organization’s creator is specified as <userId> / when accessing from outside the permitted IP address range
404 when the <userId> that was designated doesn't belong to the organization