My Catalogs

Okta Access Requests automate the process of requesting access to applications and resources.

Endusers may request entries in their resource catalog.

Manage this process directly with the following request APIs.

See Access Requests for more information on Access Requests and Identity Governance.

List all entries for the default access request catalog
OAuth 2.0:
  • okta.accessRequests.catalog.read

Lists all entries for the default access request catalog

Request
query Parameters
after
string = 20 characters

The after cursor provided by a prior request.

Example: after=cenp2rjyxK1Js2Fc41d5
filter
required
string <scim-filter>

Apply various filters by using supported catalog entry filtering properties.

Note: Query parameter percent encoding is required. See Percent-encoding

Examples:
Query param: ?filter=parent eq "<parentEntryId>"&limit=8
filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&limit=8
Query param: ?filter=parent eq "<parentEntryId>"&match=edit&limit=8
filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&match=edit&limit=8
Query param: ?filter=not(parent+pr)&limit=20
filter=not(parent%20pr)&limit=20
Query param: ?filter=not(parent+pr)&limit=20&after=cen33e47frfMB93gQ8g6
filter=not(parent%20pr)&limit=20&after=cen33e47frfMB93gQ8g6
Query param: ?filter=not(parent+pr)&match=fig&limit=8
filter=not(parent%20pr)&match=fig&limit=8
Query param: ?filter=not(parent+pr)&match=fig&limit=20&after=cen33e47frfMB93gQ8g6
filter=not(parent%20pr)&match=fig&limit=20&after=cen33e47frfMB93gQ8g6
limit
integer [ 1 .. 200 ]

The maximum number of records that will be returned in a given result.

match
string [ 3 .. 50 ] characters

The term used to match certain attributes when listing catalog entries. At least 3 characters are required for fuzzy search.

Responses
200

List of all entries in the resource catalog

400

An invalid list request

401

When authentication fails

403

When authorization fails

404

When the requested resource was not found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v2/my/catalogs/default/entries
Request samples 
Response samples 
application/json
Lists all entries that have an empty parent


{}
Retrieve an entry from my catalog
OAuth 2.0: 
  • okta.accessRequests.catalog.read
Retrieves an entry from my catalog


Request 
path Parameters
entryId
required
string  = 20 characters 
The ID of the catalog entry


 
 Example:  cenp2rjyxK1Js2Fc41d5
Responses 
200
List of all entries in the resource catalog


400
An invalid list request


401
When authentication fails


403
When authorization fails


404
When the requested resource was not found


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


get/governance/api/v2/my/catalogs/default/entries/{entryId}
Request samples 
Response samples 
application/json
{}
Retrieve an entry's request fields
OAuth 2.0: 
  • okta.accessRequests.request.read
Retrieves request fields for my catalog entry


Request fields are determined by evaluating the entry's associated
request conditions for the requester.


The highest priority matching
condition determines the approval sequence that will be used for the
requester.


If that approval sequence has requester fields, then they will
be returned as a request field.


Request 
path Parameters
entryId
required
string  = 20 characters 
The ID of the catalog entry


 
 Example:  cenp2rjyxK1Js2Fc41d5
Responses 
200
Get requester fields for an entry


401
When authentication fails


404
When the requested resource was not found


get/governance/api/v2/my/catalogs/default/entries/{entryId}/request-fields
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "ACCESS_DURATION",
      • "type": "DURATION",
      • "required": false,
      • "readOnly": true,
      • "value": "P4D"
      }
    ]
}
List all my catalog entry users
OAuth 2.0: 
  • okta.accessRequests.catalog.read
Lists all users who match the filter and could also view and request the entry.
List is only returned if the entry has request on behalf of enabled, a filter is specified and the authorized user is able to request on behalf of other users.


Request 
path Parameters
entryId
required
string  = 20 characters 
The ID of the catalog entry


 
 Example:  cenp2rjyxK1Js2Fc41d5
query Parameters
after
string
The after cursor provided by a prior request.


 
filter
required
string <scim-filter> 
Searches for users with a supported filtering expression for most properties.


Note: Query parameter percent encoding is required. See Percent-encoding


  Examples: 
Query param: ?filter=lastName sw "Smi" 
filter=lastName%20sw%20%Smi%22
Query param: ?filter=firstName sw "John" 
filter=firstName%20sw%20%22John%22
Query param: ?filter=firstName sw "John" OR lastName sw "John" 
filter=firstName%20sw%20%22John%22%20OR%lastName%20sw%20%22John%22
limit
integer  [ 1 .. 200 ] 
 Default:  20
The maximum number of records that will be returned in a given result.


 
Responses 
200
List of all requesters who may be able to request the entry


400
An invalid list request


401
When authentication fails


403
When authorization fails


404
When the requested resource was not found


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


get/governance/api/v2/my/catalogs/default/entries/{entryId}/users
Request samples 
Response samples 
application/json
Lists all users who may be requesters for the entry that the authorized user could request on behalf of


{
  • "data": [
    • {
      • "id": "00u28w6vzKKultXP98g5",
      • "email": "jessie.smith@example.com",
      • "firstName": "Jessie",
      • "lastName": "Smith"
      },
    • {
      • "id": "00u28w6vzKKultXP97g5",
      • "email": "jacky.chen@example.com",
      • "firstName": "Jacky",
      • "lastName": "Chen"
      },
    • {
      • "id": "00u28w6vzKKultXP97g6",
      • "email": "tal.gupta@example.com",
      • "firstName": "Tal",
      • "lastName": "Gupta"
      },
    • {
      • "id": "00u28w6vzKKultXP97g6",
      • "email": "chad.Beauchamp-Williams-Wrightman-Smithson@example.com",
      • "firstName": "Chad",
      • "lastName": "Beauchamp-Williams-Wrightman-Smithson"
      },
    • {
      • "id": "00u28w8vzKLultXP97g6",
      • "email": "Lorena.FernándezDeCórdoba@example.com",
      • "firstName": "Lorena",
      • "lastName": "Fernández de Córdoba"
      },
    • {
      • "id": "00u68w6vzKLultXS97g6",
      • "email": "SeraphinianaAlessandrovich.Raskolnikov-Karamazov-Smirnovich@example.com",
      • "firstName": "SeraphinianaAlessandrovich",
      • "lastName": "Raskolnikov-Karamazov-Smirnovich"
      }
    ],
  • "_links": {}
}
Retrieve a users request-fields for an entry
OAuth 2.0: 
  • okta.accessRequests.catalog.read
Retrieves the entry's request fields for the specified requester.
Request fields for the entry are only returned if the entry has request on behalf of enabled, and the authorized user is able to request on behalf of other requesters.


Request 
path Parameters
entryId
required
string  = 20 characters 
The ID of the catalog entry


 
 Example:  cenp2rjyxK1Js2Fc41d5
userId
required
string  = 20 characters 
The id of the user


 
 Example:  00ucvnr9rbONeZdRp1d7
Responses 
200
Get requester fields for an entry


401
When authentication fails


404
When the requested resource was not found


get/governance/api/v2/my/catalogs/default/entries/{entryId}/users/{userId}/request-fields
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "ACCESS_DURATION",
      • "type": "DURATION",
      • "required": false,
      • "readOnly": true,
      • "value": "P4D"
      }
    ]
}