Create an Okta Integration
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
CreateOktaIntegrationRequestData
The environment type for the Okta integration. This is for internal cosmetic reference only
demo, sandbox, development, testing, staging, production, unknown The Okta customer tenant domain
255"example.okta.com"
A description for the Okta Integration. This is for reference only and has no effect on functionality
1000The user profile key for badge ID in Okta API user schema, if applicable
255The user profile key for employee ID in Okta API user schema, if applicable
255The user profile key for alternative employee ID in Okta API user schema, if applicable
255Whether this integration handles manager relationships. If true, the integration will attempt to sync manager relationships based on the provided manager_id_child_key and manager_id_parent_key
The user profile key for the child in Okta API user schema for manager relationships, if applicable. This is required if manager_enabled is true
255The user profile key for the parent in Okta API user schema for manager relationships, if applicable. This is required if manager_enabled is true
255The number of days to retain PII for users that have been deleted or deactivated in Okta. After this period, user record PII fields will be deleted and replaced with ghost user data
0 <= x <= 1095The OAUTH scopes authorized for Okta Apps
read, none The OAUTH scopes authorized for Okta Groups
write, read, none Response
OktaIntegrationDetailedResponseData
"okitg_01hq8xyzabc123def456ghi789"
The state of the integration
staged, active, expiring, expired, deactivated Whether this is the primary integration and Identity Provider single source of truth for the organization. This is used to manage the lifecycle of Directory Users. Additional integrations can enrich user profile data, but only the primary integration will be used to create, update, or deactivate Directory Users
The environment type for the Okta integration. This is for internal cosmetic reference only
demo, sandbox, development, testing, staging, production, unknown A description for the Okta Integration. This is for reference only and has no effect on functionality
The Okta customer tenant domain
"example.okta.com"
The user profile key for badge ID in Okta API user schema, if applicable
The user profile key for employee ID in Okta API user schema, if applicable
The user profile key for alternative employee ID in Okta API user schema, if applicable
Whether this integration handles manager relationships. If true, the integration will attempt to sync manager relationships based on the provided manager_id_child_key and manager_id_parent_key
The user profile key for the child in Okta API user schema for manager relationships, if applicable. This is only used if manager_enabled is true
The user profile key for the parent in Okta API user schema for manager relationships, if applicable. This is only used if manager_enabled is true
The number of days to retain PII for users that have been deleted or deactivated in Okta. After this period, user record PII fields will be deleted and replaced with ghost user data
The OAUTH scopes authorized for Okta Apps
read, none The OAUTH scopes authorized for Okta Groups
write, read, none Whether this integration is synced automatically on a schedule. If false, the integration can only be synced manually
Custom metadata key-value pairs for this integration
The timestamps for the integration record
Count of related records
Included related resources
API hyperlinks related to the record