Skip to main content
POST
/
owners
cURL
curl --request POST \
  --url https://api.opal.dev/v1/owners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "API Owner",
  "description": "This owner represents the API team owners.",
  "access_request_escalation_period": 120
}'
{
  "owner_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "API Owner",
  "description": "This owner represents the API team owners.",
  "access_request_escalation_period": 120
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

CreateOwnerInfo Object

Description

The CreateOwnerInfo object is used to store creation info for an owner.

Usage Example

Use in the POST Owners endpoint.

​
name
string
required

The name of the owner.

Example:

"API Owner"

​
user_ids
string<uuid>[]
required

Users to add to the created owner. If setting a source_group_id this list must be empty.

Example:
[
  "7870617d-e72a-47f5-a84c-693817ab4567",
  "1520617d-e72a-47f5-a84c-693817ab48ad2"
]
​
description
string

A description of the owner.

Example:

"This owner represents the API team owners."

​
access_request_escalation_period
integer

The amount of time (in minutes) before the next reviewer is notified. Use 0 to remove escalation policy.

Example:

120

​
reviewer_message_channel_id
string

The message channel id for the reviewer channel.

Example:

"37cb7e41-12ba-46da-92ff-030abe0450b1"

​
source_group_id
string<uuid>

Sync this owner's user list with a source group.

Example:

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

Response

200 - application/json

The owner just created.

Owner Object

Description

The Owner object is used to represent an owner.

​
owner_id
string<uuid>
required

The ID of the owner.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

​
name
string

The name of the owner.

Example:

"API Owner"

​
description
string

A description of the owner.

Example:

"This owner represents the API team owners."

​
access_request_escalation_period
integer

The amount of time (in minutes) before the next reviewer is notified. Use 0 to remove escalation policy.

Example:

120

​
reviewer_message_channel_id
string<uuid> | null
Example:

"37cb7e41-12ba-46da-92ff-030abe0450b1"

​
source_group_id
string<uuid> | null
Example:

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