Users
Soda Cloud API Users Endpoints
This endpoint enables you to gather information about the user groups in your organization's Soda Cloud account, including lists of members.
This GET is a paginated API that uses the following parameters to request specific details:
size: Supply an integer value between 10 and 1000, inclusive. The default value is 1000.page: Supply an integer value. The default value is 0.search: Optionally, use this parameter to perform a fuzzy search on the user group name.
If not specified, the query gathers information for all user groups in the account and sorts the results by user group name in ascending order.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
GET /api/v1/userGroups HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"content": [
{
"name": "text",
"userGroupId": "text",
"users": [
{
"email": "text",
"firstName": "text",
"fullName": "text",
"lastName": "text",
"userId": "text"
}
]
}
],
"first": true,
"last": true,
"number": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}This endpoint enables you to create a new user group in your organization's Soda Cloud account.
The Response of this call, when successful, is 201 and contains headers Location which is a reference to the newly created User Group.
Authorization
Only users with Manage organization settings permission can update user groups.See Manage global roles for more information.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
POST /api/v1/userGroups HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"name": "text",
"userIds": [
"text"
]
}No content
This endpoint enables you to gather information about a single user group in your organization's Soda Cloud account, including lists of members.
This GET is a non-paginated API that returns a single organization based on its ID.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
GET /api/v1/userGroups/{userGroupId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"name": "text",
"userGroupId": "text",
"users": [
{
"email": "text",
"firstName": "text",
"fullName": "text",
"lastName": "text",
"userId": "text"
}
]
}This endpoint enables you to update an existing user group in your organization's Soda Cloud account.
The Response of this call, when successful, is 200 and contains updated User Group details.
Authorization
Only users with Manage organization settings permission can update user groups.See Manage global roles for more information.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
POST /api/v1/userGroups/{userGroupId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"userIds": [
"text"
]
}{
"name": "text",
"userGroupId": "text",
"users": [
{
"email": "text",
"firstName": "text",
"fullName": "text",
"lastName": "text",
"userId": "text"
}
]
}This endpoint enables you to delete an existing user group from your organization's Soda Cloud account.
In case of success, the response returns a 200 (OK) response.
In case user group is not found, the response returns a 404 (Not found) response.
Authorization
Only users with Manage organization settings permission can update user groups.See Manage global roles for more information.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
DELETE /api/v1/userGroups/{userGroupId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{}This endpoint enables you to gather information about the users in your organization's Soda Cloud account.
This GET is a paginated API that uses the following parameters to request specific details:
size: Supply an integer value between 1 and 1000, inclusive. The default value is 1000.page: Supply an integer value. The default value is 0.search: Optionally, use this parameter to perform a fuzzy search on the user first name, last name, or email address.
If not specified, the query gathers information for all users in the account and sorts the results by user name in ascending order.
Authentication
User authentication required: true
This endpoint enforces authentication using the API keys you provide in the Basic authentication header.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
GET /api/v1/users HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"content": [
{
"email": "text",
"firstName": "text",
"fullName": "text",
"lastName": "text",
"userId": "text"
}
],
"first": true,
"last": true,
"number": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}Was this helpful?