GET /api/v1/apps/{appId}/users

Lists all assigned users for an app

Servers

Path parameters

Name Type Required Description
appId String Yes

Application ID

Query parameters

Name Type Required Description
limit Integer No

Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a next link that you need to use as an opaque value (follow it, don't parse it). See Pagination.

Default value: 50

after String No

Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See Pagination.

q String No

Specifies a filter for the list of Application Users returned based on their profile attributes. The value of q is matched against the beginning of the following profile attributes: userName, firstName, lastName, and email. This filter only supports the startsWith operation that matches the q string against the beginning of the attribute values.

Note: For OIDC apps, user profiles don't contain the firstName or lastName attributes. Therefore, the query only matches against the userName or email attributes.

expand String No

An optional query parameter to return the corresponding User object in the _embedded property. Valid value: user

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.