Delegates

The Delegates API allows admins to view governance delegates for a principal (for example, an Okta user). Admins can appoint delegates to perform governance tasks and end users can appoint delegates for their own governance tasks.

List all delegate appointments
Beta
OAuth 2.0 scopes:
  • okta.governance.delegates.read
Admin roles:
  • SUPER_ADMIN

Lists all delegate appointments in your org.

You can filter delegate appointments for a specific user with the filter query parameter. You can also manage the number of records in the response with the limit and after query parameters.

The following are request examples with query parameters:

  1. Lists at most 20 delegate appointments
    /governance/api/v1/delegates?limit=20
  2. Lists the next 10 results of delegate appointments after a specific cursor
    /governance/api/v1/delegates?limit=10&after=gda123ABCXYZ456DEF
  3. Lists at most 2 delegate appointments with delegatorId equals 00ub0oNGTSWTBKOLAAAA or 00u2lxfQaw8WRlkQt0g4
    /governance/api/v1/delegates?filter=(delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20OR%20delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNS%22)&limit=2
Request
query Parameters
after
string

The pagination cursor that points to the last record of the previous request.

Example: after=00u68w6vzKLultXS97g6
filter
string

Filter expression for retrieving delegates based on specific criteria. Only the delegatorId property is supported with the eq operator.

Example: filter=delegatorId eq "00ub0oNGTSWTBKOLGLNR" OR delegatorId eq "00ub0oNGTSWTBKOLGLNS"
limit
integer [ 1 .. 200 ]
Default: 20

The maximum number of records returned in a response

Responses
200

A successful response

400

An invalid list request

401

When authentication fails

403

When authorization fails

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v1/delegates
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "gda123ABCXYZ456DEF",
      • "delegate": {
        },
      • "delegator": {
        },
      • "note": "Johnny Appleseed is on parental leave",
      • "created": "2019-08-24T14:15:22Z",
      • "createdBy": "00ub0oNGTSWTBKOLGLNR",
      • "lastUpdated": "2019-08-24T14:15:22Z",
      • "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR"
      },
    • {
      • "id": "gda123ABCXYZ456DEF",
      • "delegate": {
        },
      • "delegator": {
        },
      • "startTime": "2019-08-24T14:15:22Z",
      • "endTime": "2019-08-28T14:15:22Z",
      • "note": "Mary Lamb is on holiday",
      • "created": "2019-08-24T14:15:22Z",
      • "createdBy": "00u2lxfQaw8WRlkQt0g4",
      • "lastUpdated": "2019-08-24T14:15:22Z",
      • "lastUpdatedBy": "00u2lxfQaw8WRlkQt0g4"
      }
    ],
  • "_links": {}
}