List Users that are Organization Members
This will retrieve a list of the users that are members of the organization.
GET
/api/v0/users
Required permissions for the 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) |
isInRegistrationProcess |
boolean | Whether or not the user is in the process of registration. |
isMFAEnabled |
boolean | Whether or not the user has enabled 2-step verification. |
authenticationMethods |
array[string] | Authentication methods used (password, github, idcf, google, nifty, kddi) |
joinedAt |
number | Date and time the user became a member of the organization (in epoch seconds) |
Delete Users that are Organization Members
This will delete a user that is a member of the organization.
DELETE
/api/v0/users/<userId>
Required permissions for the API key
- Read
- Write
Response
Success
User information is returned for the user that was deleted as a member of the organization. The format is the same as List Users that are Organization Members.
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 specified <userId> is not a member of the organization |
