The Authorization Control object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

The Authorization Control object 
{
  "id": "authorization-control_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z"
}
GET /api/setup/authorization-control/{id}

Retrieve a authorization control

Retrieves the details of an existing authorization control. Supply the unique authorization control ID that was returned from a previous request.

Path parameters

id string required

The identifier of the authorization control to retrieve.

Returns

Returns the authorization control object if a valid identifier was provided.

GET /api/setup/authorization-control/{id} 
curl https://api.overplane.dev/api/setup/authorization-control/authorization-control_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "authorization-control_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z"
}
GET /api/setup/authorization-control

List all authorization controls

Returns a list of authorization controls. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of authorization control objects.

GET /api/setup/authorization-control 
curl https://api.overplane.dev/api/setup/authorization-control \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "authorization-control_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/authorization-control

Create a authorization control

Creates a new authorization control object.

Returns

Returns the newly created authorization control object if the call succeeded.

POST /api/setup/authorization-control 
curl https://api.overplane.dev/api/setup/authorization-control \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "authorization-control_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z"
}
PATCH /api/setup/authorization-control/{id}

Update a authorization control

Updates the specified authorization control by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the authorization control to update.

Returns

Returns the updated authorization control object.

PATCH /api/setup/authorization-control/{id} 
curl https://api.overplane.dev/api/setup/authorization-control/authorization-control_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json"
Response 
{
  "id": "authorization-control_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z"
}
DELETE /api/setup/authorization-control/{id}

Delete a authorization control

Permanently deletes a authorization control. This cannot be undone.

Path parameters

id string required

The identifier of the authorization control to delete.

Returns

Returns a confirmation that the authorization control has been deleted.

DELETE /api/setup/authorization-control/{id} 
curl https://api.overplane.dev/api/setup/authorization-control/authorization-control_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "authorization-control_abc123",
  "deleted": true
}