cURL

curl --request GET \
  --url https://api.opal.dev/v1/configuration-templates \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "configuration_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "admin_owner_id": "a4d7d928-783e-4599-8ec6-088d635af4ac",
      "visibility": "private",
      "linked_audit_message_channel_ids": [
        "l3cb7e41-12ba-46da-92ff-030abe0450b1",
        "f3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "request_configuration_id": "r3cb7e41-12ba-46da-92ff-030abe0450b1",
      "member_oncall_schedule_ids": [
        "23cb7e41-12ba-46da-92ff-030abe0450b1",
        "m3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "break_glass_user_ids": [
        "63cb7e41-12ba-46da-92ff-030abe0450b1",
        "b3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "require_mfa_to_approve": false,
      "require_mfa_to_connect": false
    }
  ]
}

GET

configuration-templates

cURL

curl --request GET \
  --url https://api.opal.dev/v1/configuration-templates \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "configuration_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "admin_owner_id": "a4d7d928-783e-4599-8ec6-088d635af4ac",
      "visibility": "private",
      "linked_audit_message_channel_ids": [
        "l3cb7e41-12ba-46da-92ff-030abe0450b1",
        "f3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "request_configuration_id": "r3cb7e41-12ba-46da-92ff-030abe0450b1",
      "member_oncall_schedule_ids": [
        "23cb7e41-12ba-46da-92ff-030abe0450b1",
        "m3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "break_glass_user_ids": [
        "63cb7e41-12ba-46da-92ff-030abe0450b1",
        "b3cb7e41-12ba-46da-92ff-030abe0450b2"
      ],
      "require_mfa_to_approve": false,
      "require_mfa_to_connect": false
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

One page worth of configuration templates for your organization.

PaginatedConfigurationTemplateList Object

Description

The PaginatedConfigurationTemplateList object is used to store a list of configuration templates.

Usage Example

Returned from the GET Configuration Templates endpoint.

results

object[]

Show child attributes

results.configuration_template_id

string<uuid>

The ID of the configuration template.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

results.name

string

The name of the configuration template.

Example:

"Prod AWS Template"

results.admin_owner_id

string<uuid>

The ID of the owner of the configuration template.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

results.visibility

object

The visibility info of the configuration template.

Show child attributes

results.visibility.visibility

enum<string>

required

The visibility level of the entity.

Available options:

GLOBAL,

LIMITED

Example:

"GLOBAL"

results.visibility.visibility_group_ids

string<uuid>[]

Example:

"private"

results.linked_audit_message_channel_ids

string<uuid>[]

The IDs of the audit message channels linked to the configuration template.

Example:

[
  "37cb7e41-12ba-46da-92ff-030abe0450b1",
  "37cb7e41-12ba-46da-92ff-030abe0450b2"
]

results.request_configuration_id

string<uuid>

The ID of the request configuration linked to the configuration template.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

results.member_oncall_schedule_ids

string<uuid>[]

The IDs of the on-call schedules linked to the configuration template.

Example:

[
  "37cb7e41-12ba-46da-92ff-030abe0450b1",
  "7c86c85d-0651-43e2-a748-d69d658418e8"
]

results.break_glass_user_ids

string<uuid>[]

The IDs of the break glass users linked to the configuration template.

Example:

[
  "37cb7e41-12ba-46da-92ff-030abe0450b1",
  "37cb7e41-12ba-46da-92ff-030abe0450b2"
]

results.require_mfa_to_approve

boolean

A bool representing whether or not to require MFA for reviewers to approve requests for this configuration template.

Example:

false

results.require_mfa_to_connect

boolean

A bool representing whether or not to require MFA to connect to resources associated with this configuration template.

Example:

false

results.ticket_propagation

object

Configuration for ticket propagation, when enabled, a ticket will be created for access changes related to the users in this resource.

Show child attributes

results.ticket_propagation.enabled_on_grant

boolean

required

results.ticket_propagation.enabled_on_revocation

boolean

required

results.ticket_propagation.ticket_provider

enum<string>

The third party ticketing platform provider.

Available options:

JIRA,

LINEAR,

SERVICE_NOW

Example:

"LINEAR"

results.ticket_propagation.ticket_project_id

string

results.custom_request_notification

string | null

Custom request notification sent upon request approval for this configuration template.

Maximum string length: 800

Example:

"Check your email to register your account."

Put bundles visibility Put configuration templates

⌘I

API Concepts

SDKs

Opal API

Get configuration templates

Authorizations

Response

PaginatedConfigurationTemplateList Object

Description

Usage Example