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 accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
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 accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
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 accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
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 accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
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 accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
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.includeDisabled: Optionally, set totrueto include users that have been disabled in the organization. The default value isfalse.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 enabled users in the account, plus disabled users when includeDisabled=true, and sorts the results by user name in ascending order.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Any Soda Cloud user in your organization may execute this query.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
GET /api/v1/users HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"content": [
{
"email": "text",
"enabled": true,
"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 invite users to your organization's Soda Cloud account.
Invited users will receive an email with a link to set their password and join your organization in Soda Cloud. Once they complete the setup, they will have access to Soda Cloud based on the roles and permissions you assign.
If your organization is using SSO, invited users will receive an invitation email with a link to Soda Cloud. When they log in using SSO, they are immediately added to the Soda Cloud organization.
You can invite up to 10 users per request. The response contains lists of successful and failed invitations.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Tags
Users
Rate limiting
10 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Too many requests
Internal server error
POST /api/v1/users HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"emails": [
"text"
]
}{
"failedInvitations": [
{
"email": "text",
"error": "text"
}
],
"validInvitations": [
"text"
]
}This endpoint disables a user in your organization's Soda Cloud account.
Disabling a user deactivates their membership in the organization. The user is not deleted and can be re-enabled later with the enable user endpoint.
Their active sessions are revoked immediately, so they can no longer sign in, including through SSO.
In organizations that provision users over SCIM, the identity provider stays the source of truth: a later sync that reports the user as active will re-enable them.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Auditable
This API is marked as audited on execution.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
POST /api/v1/users/{userId}/disable HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{}This endpoint re-enables a user in your organization's Soda Cloud account that was previously disabled.
Enabling a user reactivates their membership in the organization with the roles and group memberships they had before they were disabled. They can sign in again, including through SSO.
The list users endpoint returns disabled users only when you pass includeDisabled=true, and marks them with enabled: false.
In organizations that provision users over SCIM, the identity provider stays the source of truth: a later sync that reports the user as inactive will disable them again.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Authorization
Users must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.
Auditable
This API is marked as audited on execution.
Tags
Users
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
POST /api/v1/users/{userId}/enable HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{}Last updated
Was this helpful?