Solace DocsDeveloper HubSolace Community
API Reference

(Beta) Get a list of users in your account

get
https://api.solace.cloud/api/v2/platform/users

Get a list of users. You can retrieve a list of users matching on email, name, identifiers, or roles.

Token Permissions: [ iam_users:get ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

The page number to retrieve.

integer
1 to 100
Defaults to 10

The number of users to return on each page.

string

The name of the user. You can enter a partial string into the field to match multiple users.

string

The email address of the user. You can enter a partial string into the field to match multiple users.

ids
array of strings

The list of unique identifiers for users.

ids
roles
array of strings

The unique identifiers of the roles that are assigned to the user.

roles
groups
array of strings

The unique identifiers of the groups that are assigned to the user.

groups
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated about 1 year ago