cURL

curl --request GET \
  --url https://api.opal.dev/v1/groups/users/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07.000Z",
      "email": "[email protected]"
    },
    {
      "full_name": "Brett Ashley",
      "user_id": "7646aa9a-e2ee-4eb5-8c62-91f29038a373",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-02-03T12:33:02.000Z",
      "email": "[email protected]"
    }
  ]
}

GET

groups

users

{user_id}

cURL

curl --request GET \
  --url https://api.opal.dev/v1/groups/users/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07.000Z",
      "email": "[email protected]"
    },
    {
      "full_name": "Brett Ashley",
      "user_id": "7646aa9a-e2ee-4eb5-8c62-91f29038a373",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-02-03T12:33:02.000Z",
      "email": "[email protected]"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id

string<uuid>

required

The ID of the user whose groups to return.

Query Parameters

cursor

string

The pagination cursor value.

page_size

integer

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

Required range: x <= 1000

Response

200 - application/json

The groups that the user is a member of.

results

object[]

Show child attributes

results.group_id

string<uuid>

required

The ID of the group.

Example:

"1b978423-db0a-4037-a4cf-f79c60cb67b3"

results.group_name

string

required

The name of the group.

Example:

"API Group"

results.description

string

required

The description of the group.

Example:

"Group required to request API's"

results.user_id

string<uuid>

required

The ID of the user.

Example:

"29827fb8-f2dd-4e80-9576-28e31e9934ac"

results.full_name

string

required

The user's full name.

Example:

"Jake Barnes"

results.email

string

required

The user's email.

Example:

"[email protected]"

results.access_level

object

Access Level Object

Description

The GroupAccessLevel object is used to represent the level of access that a user has to a group or a group has to a group. The "default" access level is a GroupAccessLevel object whose fields are all empty strings.

Usage Example

View the GroupAccessLevel of a group/user or group/group pair to see the level of access granted to the group.

Show child attributes

results.access_level.access_level_name

string

required

The human-readable name of the access level.

Example:

"Developer"

results.access_level.access_level_remote_id

string

required

The machine-readable identifier of the access level.

Example:

20

Example:

{
  "access_level_name": "Developer",
  "access_level_remote_id": 20
}

results.expiration_date

string<date-time> | null

The day and time the user's access will expire.

Example:

"2022-01-23T04:56:07.000Z"

results.propagation_status

object

The state of whether the push action was propagated to the remote system. If this is null, the access was synced from the remote system.

Show child attributes

results.propagation_status.status

enum<string>

required

The status of whether the user has been synced to the group or resource in the remote system.

Available options:

SUCCESS,

ERR_REMOTE_INTERNAL_ERROR,

ERR_REMOTE_USER_NOT_FOUND,

ERR_REMOTE_USER_NOT_LINKED,

ERR_REMOTE_RESOURCE_NOT_FOUND,

ERR_REMOTE_THROTTLE,

ERR_NOT_AUTHORIZED_TO_QUERY_RESOURCE,

ERR_REMOTE_PROVISIONING_VIA_IDP_FAILED,

ERR_IDP_EMAIL_UPDATE_CONFLICT,

ERR_TIMEOUT,

ERR_UNKNOWN,

ERR_OPAL_INTERNAL_ERROR,

ERR_ORG_READ_ONLY,

ERR_OPERATION_UNSUPPORTED,

PENDING,

PENDING_MANUAL_PROPAGATION,

PENDING_TICKET_CREATION,

ERR_TICKET_CREATION_SKIPPED,

ERR_DRY_RUN_MODE_ENABLED,

ERR_HR_IDP_PROVIDER_NOT_LINKED,

ERR_REMOTE_UNRECOVERABLE_ERROR

Example:

["SUCCESS"]

string | null

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

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

string | null

The cursor used to obtain the current result page.

Example:

"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ"

Delete groups users Get group bindings

⌘I

API Concepts

SDKs

Opal API

Get groupsusers

Authorizations

Path Parameters

Query Parameters

Response

Access Level Object

Description

Usage Example