Users | Documentation

Get user groups

get

/api/v1/userGroups

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

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

searchstringOptional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

firstbooleanRequired

lastbooleanRequired

numberinteger · int32Required

sizeinteger · int32Required

totalElementsinteger · int32Required

totalPagesinteger · int32Required

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/userGroups

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
}

Create user group

post

/api/v1/userGroups

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

Authorizations

AuthorizationstringRequired

Body

namestringOptional

userIdsstring[]Optional

Responses

200

Successful response

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/userGroups

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

Get user group

get

/api/v1/userGroups/{userGroupId}

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

Authorizations

AuthorizationstringRequired

Path parameters

userGroupIdstringRequired

Responses

200

Successful response

application/json

namestringRequired

userGroupIdstringRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/userGroups/{userGroupId}

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"
    }
  ]
}

Update user group

post

/api/v1/userGroups/{userGroupId}

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

Authorizations

AuthorizationstringRequired

Path parameters

userGroupIdstringRequired

Body

userIdsstring[]Optional

Responses

200

Successful response

application/json

namestringRequired

userGroupIdstringRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/userGroups/{userGroupId}

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"
    }
  ]
}

Delete user group

delete

/api/v1/userGroups/{userGroupId}

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

Authorizations

AuthorizationstringRequired

Path parameters

userGroupIdstringRequired

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

delete

/api/v1/userGroups/{userGroupId}

DELETE /api/v1/userGroups/{userGroupId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{}

Get users

get

/api/v1/users

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

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

searchstringOptional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

firstbooleanRequired

lastbooleanRequired

numberinteger · int32Required

sizeinteger · int32Required

totalElementsinteger · int32Required

totalPagesinteger · int32Required

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/users

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
}

Invite users

post

/api/v1/users

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 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

10 requests/60 seconds

Authorizations

AuthorizationstringRequired

Body

emailsstring[]Required

Responses

200

Successful response

application/json

validInvitationsstring[]Optional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/users

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"
  ]
}

hashtagGet user groups

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagCreate user group

hashtagAuthorization

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagGet user group

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagUpdate user group

hashtagAuthorization

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagDelete user group

hashtagAuthorization

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagGet users

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

hashtagInvite users

hashtagAuthentication

hashtagAuthorization

hashtagTags

hashtagRate limiting

Get user groups

Authentication

Authorization

Tags

Rate limiting

Create user group

Authorization

Authentication

Authorization

Tags

Rate limiting

Get user group

Authentication

Authorization

Tags

Rate limiting

Update user group

Authorization

Authentication

Authorization

Tags

Rate limiting

Delete user group

Authorization

Authentication

Authorization

Tags

Rate limiting

Get users

Authentication

Authorization

Tags

Rate limiting

Invite users

Authentication

Authorization

Tags

Rate limiting