/vendors/okta
/vendors/okta endpoints are used to register, get, update and delete secrets of a tenant in Zesty. This will be used for the Okta SSO flow.
Only Zesty users with role admin or owner are authorized to use these APIs.
Fields:
| name | description |
|---|---|
| client_domain | the Okta tenant's domain URL, also called issuer |
| ecosystem_zuid | the ecosystem where the Okta organization will be mapped |
| client_id | public identifier for the client that is used to generate authorization code for the user |
| client_secret | private identifier for the client that is used to generate the access token, refresh token and id_token which contains the user information |
Creates a new Okta Org record based on the ecosystem the user have admin/owner permissions.
| Key | Description |
|---|---|
| oktaorg_zuid | [string] Required. The ecosystem ZUID the user have admin/owner permissions. |
| client_id | [string] Required. |
| client_secret | [string] Required. |
| client_domain | [string] Required. URL encoded domain. E.g. "https://clientdomain.com" |
URL Endpoint
https://accounts.api.zesty.io/v1/vendors/oktaAuthentication Header
Bearer YOUR_APP_SID Request Body
{
"ecosystem_zuid": {{ecosystem_zuid}},
"client_id": "client_id",
"client_secret": "client_secret",
"client_domain": "client_domain"
}
Retrieves an Okta Org record based on the client_domain.
This API supports user session token (bearer token) as long as the user is a Zesty admin/owner as well as support for Service-to-Service token using X-Auth custom header request.
URL Endpoint
https://accounts.api.zesty.io/v1/vendors/okta?clientDomain={{client_domain}}Authentication Header
Bearer YOUR_APP_SID Updates an Okta Org record based on its ZUID.
| Key | Description |
|---|---|
| oktaorg_zuid | [string] Optional. The new ecosystem's ZUID the user have admin/owner permissions. |
| client_id | [string] Optional. The new client_id. Note that client_secret will be required. |
| client_secret | [string] Optional. The new client_secret. Note the client_id will be required. |
| client_domain | [string] Optional. New client_domain. E.g. "https://clientdomain.com" |
URL Endpoint
https://accounts.api.zesty.io/v1/vendors/okta/{{ecosystem_zuid}}Authentication Header
Bearer YOUR_APP_SID Request Body
{
"ecosystem_zuid": {{ecosystem_zuid}},
"client_id": "client_id",
"client_secret": "client_secret",
"client_domain": "client_domain"
}