org-user-management (1.0)
Download OpenAPI specification:Download
This API provides the ability to manage users within an organization.
Update your user data across all organizations (name, email)
Update your user data across all organizations. This endpoint can only be used if you are connected via a username-password connection. If you are connected via a third-party connection, then you will need to update your user data via that provider.
Request Body schema: application/jsonrequired
The updated user data. Any omitted fields will be left unchanged.
string | |
| name | string |
Responses
Request samples
- Payload
{- "email": "string",
- "name": "string"
}Response samples
- 200
{- "email": "string",
- "id": "string",
- "name": "string"
}List users in your organization
query Parameters
| page_number | integer >= 1 Default: 1 The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200. |
| page_size | integer [ 0 .. 100 ] Default: 100 The number of items to return per page. The maximum value is 100. If the value is greater than 100, then 100 will be used. |
| name_search | string >= 3 characters ^[a-zA-Z ]{3,}$ A case insensitive search string for filtering users by name. |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "email": "string",
- "id": "string",
- "name": "string"
}
]
}Reset a user's password
Reset a user's password by sending a password reset email. This endpoint only changes the password for users who have a username and password connection. If the user logs in with a third-party connection such as google-oauth2, then they will need to have their credentials reset via that provider.
path Parameters
| id | string The unique id of the resource |
Responses
Update a user's roles by completely replacing them with the given roles
path Parameters
| id | string The unique id of the resource |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
[- "admin"
]Invite a user to your organization
Invite a user to your organization, sending them an invite email to complete registration. The user will be created with the given roles once they respond.
Request Body schema: application/jsonrequired
Describes the email to be sent, and the list of roles to be assigned.
| connection required | string or null (ConnectionType) Default: "google-oauth2" Value: "google-oauth2" The type of connection which is used to log in, such as google-oauth2. If no connection is provided, then the user will be required to create an account with a username and password. |
| email required | string |
| name required | string |
| roles required | Array of strings (PermissionRole) Items Enum: "admin" "developer" "analyst" |
Responses
Request samples
- Payload
{- "connection": "google-oauth2",
- "email": "string",
- "name": "string",
- "roles": [
- "admin"
]
}