Note: This API is only available if you're subscribed to Okta Identity Governance or Secure Partner Access. Contact your Customer Success Manager or Account Executive for more information.
The Realms API provides operations to manage realms. See Manage realms.
Lists all Realms
limit | integer <int32> Default: 200 Specifies the number of results returned. Defaults to 10 if |
after | string The cursor used for pagination. It represents the last privileged resource ID returned in the previous fetch operation. Example: after=oprbuthToCeLWOBwh0g4 |
search | string Searches for realms with a supported filtering expression for most properties. Searches for realms can be filtered by the contains ( |
sortBy | string Specifies the field to sort by and can be any single property (for search queries only) Example: sortBy=profile.name |
sortOrder | string Default: "asc" Specifies the sort order: |
OK
Forbidden
Too Many Requests
[- {
- "id": "guox9jQ16k9V8IFEL0g3",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z",
- "isDefault": false,
- "profile": {
- "name": "Car Co",
- "realmType": "PARTNER"
}, - "_links": {
- "self": {
- "rel": "self",
- "method": "GET"
}
}
}
]
Creates a new realm
Success
Bad Request
Forbidden
Too Many Requests
{- "profile": {
- "name": "string",
- "realmType": "PARTNER"
}
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "isDefault": true,
- "lastUpdated": "2019-08-24T14:15:22Z",
- "profile": {
- "name": "string",
- "realmType": "PARTNER"
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
Retrieves a realm
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "guox9jQ16k9V8IQWL0g3",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z",
- "isDefault": true,
- "profile": {
- "name": "Default realm"
}, - "_links": {
- "self": {
- "rel": "self",
- "method": "GET"
}
}
}
Replaces the realm profile
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "profile": {
- "name": "string",
- "realmType": "PARTNER"
}
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "isDefault": true,
- "lastUpdated": "2019-08-24T14:15:22Z",
- "profile": {
- "name": "string",
- "realmType": "PARTNER"
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
Deletes a realm permanently. This operation can only be performed after disassociating other entities like users and identity providers from a realm.
No Content
Bad Request
Forbidden
Not Found
Too Many Requests
{- "errorCauses": [
- {
- "errorSummary": "string"
}
], - "errorCode": "string",
- "errorId": "string",
- "errorLink": "string",
- "errorSummary": "string"
}