OPopal
users

GET /users/remote_users

Returns a list of remote users for your organization.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Query parameters

third_party_providerThirdPartyProviderEnum[]

Filter remote users by their third party provider.

[
  "GIT_HUB"
]
user_idstring[]

Filter remote users by their user ID.

remote_idstring[]

Filter remote users by their remote ID.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

Response

One page worth users in your organization.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "remote_id": 1234567890,
      "third_party_provider": "GIT_LAB"
    },
    {
      "user_id": "29827fb8-f2dd-4e80-9576-238979927392",
      "remote_id": "remoteid123",
      "third_party_provider": "GIT_HUB"
    }
  ]
}

Changes

No recorded changes to this operation across all 43 revisions of this API.