OPopal
requests

POST /requests

Changed on

Create an access request

Request

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

Request body

target_user_idstring uuid

The ID of the user to be granted access. Should not be specified if target_group_id is specified.

target_group_idstring uuid

The ID of the group the request is for. Should not be specified if target_user_id is specified.

initiated_by_user_idstring uuid

The ID of the user who asked for this access, for callers filing a request on someone else's behalf. Opal records this claim as given and does not verify it, so it never affects authorization, reviewer routing, or who may cancel the request; the authenticated caller remains the requester. Must be a user of your organization. Only accepted from a service user for which an Opal admin has enabled "Let this service user record who asked for access" under Settings on the service user's page; any other caller receives a 403 when this field is set.

reasonstring required
duration_minutesinteger required

The duration of the request in minutes. -1 represents an indefinite duration

Example request

{
  "resources": [
    {
      "id": "group283-ca87-4a8a-bdbb-df212eca5353",
      "access_level_remote_id": "arn:aws:iam::490306337630:role/SupportUser",
      "access_level_name": "arn:aws:iam::490306337630:role/SupportUser"
    }
  ],
  "groups": [
    {
      "id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "access_level_remote_id": "arn:aws:iam::490306337630:role/SupportUser",
      "access_level_name": "arn:aws:iam::490306337630:role/SupportUser"
    }
  ],
  "target_user_id": "userd283-ca87-4a8a-bdbb-df212eca5353",
  "target_group_id": "userd283-ca87-4a8a-bdbb-df212eca5353",
  "initiated_by_user_id": "userd283-ca87-4a8a-bdbb-df212eca5353",
  "support_ticket": {
    "ticketing_provider": "LINEAR"
  }
}

Response

The resulting request.

idstring uuid

Example response

{
  "id": "4baf8423-db0a-4037-a4cf-f79c60cb67a5"
}

Changes

  • c0ce333f6196Revision changes
    • info

      added the new optional request property

  • c5dec6811e07Revision changes
    • info

      added the new CALLOUT enum value to the request property //

    • info

      added the new MULTI_SELECT enum value to the request property //