OPopal
configuration-templates

POST /configuration-templates

Changed on

Creates a configuration template.

Request

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

Request body

admin_owner_idstring uuid required

The ID of the owner of the configuration template.

linked_audit_message_channel_idsstring[]

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

member_oncall_schedule_idsstring[]

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

break_glass_user_idsstring[]

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

require_mfa_to_approveboolean required

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

require_mfa_to_connectboolean required

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

requires_forfeit_reasonboolean

A bool representing whether or not a reason is required when forfeiting access to resources or groups using this configuration template.

namestring required

The name of the configuration template.

custom_request_notificationstring nullable

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

Example request

{
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "visibility": "private",
  "linked_audit_message_channel_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "request_configuration_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "member_oncall_schedule_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "break_glass_user_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "require_mfa_to_approve": false,
  "require_mfa_to_connect": false,
  "name": "Prod AWS Template"
}

Response

The configuration template just created.

configuration_template_idstring uuid

The ID of the configuration template.

namestring

The name of the configuration template.

admin_owner_idstring uuid

The ID of the owner of the configuration template.

linked_audit_message_channel_idsstring[]

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

request_configuration_idstring uuid

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

member_oncall_schedule_idsstring[]

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

break_glass_user_idsstring[]

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

require_mfa_to_approveboolean

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

require_mfa_to_connectboolean

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

requires_forfeit_reasonboolean

A bool representing whether or not a reason is required when forfeiting access to resources or groups using this configuration template.

custom_request_notificationstring nullable

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

Example response

{
  "configuration_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "visibility": "private",
  "linked_audit_message_channel_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "request_configuration_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "member_oncall_schedule_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "break_glass_user_ids": [
    "37cb7e41-12ba-46da-92ff-030abe0450b1",
    "37cb7e41-12ba-46da-92ff-030abe0450b2"
  ],
  "require_mfa_to_approve": false,
  "require_mfa_to_connect": false,
  "name": "Prod AWS Template"
}

Changes

  • 8fce5da23873Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 28c861b91406Revision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ///