Linkedobject 3 endpoints

POST /api/v1/meta/schemas/user/linkedObjects

Success

operationId: LinkedObject_createLinkedObject

Request Body

required

application/json

schema LinkedObject

Property	Type	Required
_links	object	optional
primary	object	optional
└ name	string	optional
└ type	string	optional
└ title	string	optional
└ description	string	optional
associated	object	optional
└ name	string	optional
└ type	string	optional
└ title	string	optional
└ description	string	optional

Responses

201

Created

POST /api/v1/meta/schemas/user/linkedObjects

DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

Success

operationId: LinkedObject_deleteUserLinkedObject

Parameters

Name	In	Required	Type	Description
linkedObjectName	path	required	string	—

Responses

204

No Content

DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

GET /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

Success

operationId: LinkedObject_getUserLinkedObjects

Parameters

Name	In	Required	Type	Description
linkedObjectName	path	required	string	—

Responses

200

Success

GET /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}

Log 1 endpoints

GET /api/v1/logs Fetch a list of events from your Okta organization system log.

The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API

operationId: Log_getListEvents

Parameters

Name	In	Required	Type	Description
since	query	optional	string	—
until	query	optional	string	—
filter	query	optional	string	—
q	query	optional	string	—
limit	query	optional	integer	—
sortOrder	query	optional	string	—
after	query	optional	string	—

Responses

200

Success

GET /api/v1/logs

Networkzone 7 endpoints

GET /api/v1/zones List Network Zones

Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.

operationId: NetworkZone_listZones

Parameters

Name	In	Required	Type	Description
after	query	optional	string	Specifies the pagination cursor for the next page of network zones
limit	query	optional	integer	Specifies the number of results for a page
filter	query	optional	string	Filters zones by usage or id expression

Responses

200

Success

GET /api/v1/zones

POST /api/v1/zones Add Network Zone

Adds a new network zone to your Okta organization.

operationId: NetworkZone_createNew

Request Body

application/json

schema NetworkZone

Property	Type	Required
id	string	optional
asns	array	optional
name	string	optional
type	string	optional
usage	string	optional
_links	object	optional
status	string	optional
system	boolean	optional
created	string	optional
proxies	array	optional
└ type	string	optional
└ value	string	optional
gateways	array	optional
└ type	string	optional
└ value	string	optional
locations	array	optional
└ region	string	optional
└ country	string	optional
proxyType	string	optional
lastUpdated	string	optional

Responses

200

Success

POST /api/v1/zones

DELETE /api/v1/zones/{zoneId} Delete Network Zone

Removes network zone.

operationId: NetworkZone_removeZone

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Responses

200

Success

DELETE /api/v1/zones/{zoneId}

GET /api/v1/zones/{zoneId} Get Network Zone

Fetches a network zone from your Okta organization by id.

operationId: NetworkZone_getById

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Responses

200

Success

GET /api/v1/zones/{zoneId}

PUT /api/v1/zones/{zoneId} Update Network Zone

Updates a network zone in your organization.

operationId: NetworkZone_updateZone

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Request Body

application/json

schema NetworkZone

Property	Type	Required
id	string	optional
asns	array	optional
name	string	optional
type	string	optional
usage	string	optional
_links	object	optional
status	string	optional
system	boolean	optional
created	string	optional
proxies	array	optional
└ type	string	optional
└ value	string	optional
gateways	array	optional
└ type	string	optional
└ value	string	optional
locations	array	optional
└ region	string	optional
└ country	string	optional
proxyType	string	optional
lastUpdated	string	optional

Responses

200

Success

PUT /api/v1/zones/{zoneId}

POST /api/v1/zones/{zoneId}/lifecycle/activate Activate Network Zone

Activate Network Zone

operationId: NetworkZone_activateLifecycle

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Responses

200

Success

POST /api/v1/zones/{zoneId}/lifecycle/activate

POST /api/v1/zones/{zoneId}/lifecycle/deactivate Deactivate Network Zone

Deactivates a network zone.

operationId: NetworkZone_deactivateZoneLifecycle

Parameters

Name	In	Required	Type	Description
zoneId	path	required	string	—

Responses

200

Success

POST /api/v1/zones/{zoneId}/lifecycle/deactivate

Org 17 endpoints

GET /api/v1/org Get org settings

Get settings of your organization.

operationId: Org_getSettings

Responses

200

Success

GET /api/v1/org

POST /api/v1/org Partial update Org setting

Partial update settings of your organization.

operationId: Org_updateSettings

Request Body

application/json

schema OrgSetting

Property	Type	Required
id	string	optional
city	string	optional
state	string	optional
_links	object	optional
status	string	optional
country	string	optional
created	string	optional
website	string	optional
address1	string	optional
address2	string	optional
expiresAt	string	optional
subdomain	string	optional
postalCode	string	optional
companyName	string	optional
lastUpdated	string	optional
phoneNumber	string	optional
supportPhoneNumber	string	optional
endUserSupportHelpURL	string	optional

Responses

200

Success

POST /api/v1/org

PUT /api/v1/org Update Org setting

Update settings of your organization.

operationId: Org_updateSetting

Request Body

application/json

schema OrgSetting

Property	Type	Required
id	string	optional
city	string	optional
state	string	optional
_links	object	optional
status	string	optional
country	string	optional
created	string	optional
website	string	optional
address1	string	optional
address2	string	optional
expiresAt	string	optional
subdomain	string	optional
postalCode	string	optional
companyName	string	optional
lastUpdated	string	optional
phoneNumber	string	optional
supportPhoneNumber	string	optional
endUserSupportHelpURL	string	optional

Responses

200

Success

PUT /api/v1/org

GET /api/v1/org/contacts Get org contact types

Gets Contact Types of your organization.

operationId: Org_listContactTypes

Responses

200

Success

GET /api/v1/org/contacts

GET /api/v1/org/contacts/{contactType} Get org contact user

Retrieves the URL of the User associated with the specified Contact Type.

operationId: Org_getContactUser

Parameters

Name	In	Required	Type	Description
contactType	path	required	string	—

Responses

200

Success

GET /api/v1/org/contacts/{contactType}

PUT /api/v1/org/contacts/{contactType} Update org contact user

Updates the User associated with the specified Contact Type.

operationId: Org_updateContactUser

Parameters

Name	In	Required	Type	Description
contactType	path	required	string	—

Request Body

required

application/json

schema UserIdString

Property	Type	Required
userId	string	optional

Responses

200

Success

PUT /api/v1/org/contacts/{contactType}

POST /api/v1/org/logo Update org logo

Updates the logo for your organization.

operationId: Org_updateOrganizationLogo

Request Body

multipart/form-data

schema ApplicationUpdateLogoRequest

Property	Type	Required
file	string	required

Responses

201

Created

POST /api/v1/org/logo

GET /api/v1/org/preferences Get org preferences

Gets preferences of your organization.

operationId: Org_getOrgPreferences

Responses

200

Success

GET /api/v1/org/preferences

POST /api/v1/org/preferences/hideEndUserFooter Show Okta UI Footer

Hide the Okta UI footer for all end users of your organization.

operationId: Org_hideEndUserFooter

Responses

200

Success

POST /api/v1/org/preferences/hideEndUserFooter

POST /api/v1/org/preferences/showEndUserFooter Show Okta UI Footer

Makes the Okta UI footer visible for all end users of your organization.

operationId: Org_makeOktaUiFooterVisible

Responses

200

Success

POST /api/v1/org/preferences/showEndUserFooter

GET /api/v1/org/privacy/oktaCommunication Get Okta Communication Settings

Gets Okta Communication Settings of your organization.

operationId: Org_getOktaCommunicationSettings

Responses

200

Success

GET /api/v1/org/privacy/oktaCommunication

POST /api/v1/org/privacy/oktaCommunication/optIn Opt in all users to Okta Communication emails

Opts in all users of this org to Okta Communication emails.

operationId: Org_optInOktaCommunicationEmails

Responses

200

Success

POST /api/v1/org/privacy/oktaCommunication/optIn

POST /api/v1/org/privacy/oktaCommunication/optOut Opt out all users from Okta Communication emails

Opts out all users of this org from Okta Communication emails.

operationId: Org_optOutOktaCommunicationEmails

Responses

200

Success

POST /api/v1/org/privacy/oktaCommunication/optOut

GET /api/v1/org/privacy/oktaSupport Get Okta Support settings

Gets Okta Support Settings of your organization.

operationId: Org_getOktaSupportSettings

Responses

200

Success

GET /api/v1/org/privacy/oktaSupport

POST /api/v1/org/privacy/oktaSupport/extend Extend Okta Support

Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.

operationId: Org_extendOktaSupport

Responses

200

Success

POST /api/v1/org/privacy/oktaSupport/extend

POST /api/v1/org/privacy/oktaSupport/grant Grant Okta Support

Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours.

operationId: Org_grantOktaSupportAccess

Responses

200

Success

POST /api/v1/org/privacy/oktaSupport/grant

POST /api/v1/org/privacy/oktaSupport/revoke Extend Okta Support

Revokes Okta Support access to your organization.

operationId: Org_extendOktaSupport

Responses

200

Success

POST /api/v1/org/privacy/oktaSupport/revoke

Policy 14 endpoints

GET /api/v1/policies

Gets all policies with the specified type.

operationId: Policy_getAllWithType

Parameters

Name	In	Required	Type	Description
type	query	required	string	—
status	query	optional	string	—
expand	query	optional	string	—

Responses

200

Success

GET /api/v1/policies

POST /api/v1/policies

Creates a policy.

operationId: Policy_createNewPolicy

Parameters

Name	In	Required	Type	Description
activate	query	optional	boolean	—

Request Body

application/json

schema Policy

Property	Type	Required
id	string	optional
name	string	optional
type	string	optional
_links	object	optional
status	string	optional
system	boolean	optional
created	string	optional
priority	integer	optional
_embedded	object	optional
conditions	object	optional
└ app	object	optional
└ exclude	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ include	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ apps	object	optional
└ exclude	array	optional
└ include	array	optional
└ risk	object	optional
└ behaviors	array	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ inactivity	object	optional
└ unit	string	optional
└ number	integer	optional
└ passwordExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleStatus	string	optional
└ userLifecycleAttribute	object	optional
└ attributeName	string	optional
└ matchingValue	string	optional
└ device	object	optional
└ rooted	boolean	optional
└ migrated	boolean	optional
└ platform	object	optional
└ types	array	optional
└ supportedMDMFrameworks	array	optional
└ trustLevel	string	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ people	object	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ scopes	object	optional
└ include	array	optional
└ clients	object	optional
└ include	array	optional
└ context	object	optional
└ expression	string	optional
└ network	object	optional
└ exclude	array	optional
└ include	array	optional
└ connection	string	optional
└ platform	object	optional
└ exclude	array	optional
└ os	object	optional
└ type	string	optional
└ include	array	optional
└ os	object	optional
└ type	string	optional
└ riskScore	object	optional
└ level	string	optional
└ grantTypes	object	optional
└ include	array	optional
└ userStatus	object	optional
└ value	string	optional
└ authContext	object	optional
└ authType	string	optional
└ authProvider	object	optional
└ include	array	optional
└ provider	string	optional
└ mdmEnrollment	object	optional
└ enrollment	string	optional
└ blockNonSafeAndroid	boolean	optional
└ userIdentifier	object	optional
└ type	string	optional
└ patterns	array	optional
└ value	string	optional
└ matchType	string	optional
└ attribute	string	optional
└ identityProvider	object	optional
└ idpIds	array	optional
└ provider	string	optional
└ …1 more	object	optional
description	string	optional
lastUpdated	string	optional

Responses

200

Success

POST /api/v1/policies

DELETE /api/v1/policies/{policyId}

Removes a policy.

operationId: Policy_removePolicyOperation

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Responses

200

Success

DELETE /api/v1/policies/{policyId}

GET /api/v1/policies/{policyId}

Gets a policy.

operationId: Policy_getPolicy

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
expand	query	optional	string	—

Responses

200

Success

GET /api/v1/policies/{policyId}

PUT /api/v1/policies/{policyId}

Updates a policy.

operationId: Policy_updateOperation

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Request Body

application/json

schema Policy

Property	Type	Required
id	string	optional
name	string	optional
type	string	optional
_links	object	optional
status	string	optional
system	boolean	optional
created	string	optional
priority	integer	optional
_embedded	object	optional
conditions	object	optional
└ app	object	optional
└ exclude	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ include	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ apps	object	optional
└ exclude	array	optional
└ include	array	optional
└ risk	object	optional
└ behaviors	array	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ inactivity	object	optional
└ unit	string	optional
└ number	integer	optional
└ passwordExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleStatus	string	optional
└ userLifecycleAttribute	object	optional
└ attributeName	string	optional
└ matchingValue	string	optional
└ device	object	optional
└ rooted	boolean	optional
└ migrated	boolean	optional
└ platform	object	optional
└ types	array	optional
└ supportedMDMFrameworks	array	optional
└ trustLevel	string	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ people	object	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ scopes	object	optional
└ include	array	optional
└ clients	object	optional
└ include	array	optional
└ context	object	optional
└ expression	string	optional
└ network	object	optional
└ exclude	array	optional
└ include	array	optional
└ connection	string	optional
└ platform	object	optional
└ exclude	array	optional
└ os	object	optional
└ type	string	optional
└ include	array	optional
└ os	object	optional
└ type	string	optional
└ riskScore	object	optional
└ level	string	optional
└ grantTypes	object	optional
└ include	array	optional
└ userStatus	object	optional
└ value	string	optional
└ authContext	object	optional
└ authType	string	optional
└ authProvider	object	optional
└ include	array	optional
└ provider	string	optional
└ mdmEnrollment	object	optional
└ enrollment	string	optional
└ blockNonSafeAndroid	boolean	optional
└ userIdentifier	object	optional
└ type	string	optional
└ patterns	array	optional
└ value	string	optional
└ matchType	string	optional
└ attribute	string	optional
└ identityProvider	object	optional
└ idpIds	array	optional
└ provider	string	optional
└ …1 more	object	optional
description	string	optional
lastUpdated	string	optional

Responses

200

Success

PUT /api/v1/policies/{policyId}

POST /api/v1/policies/{policyId}/lifecycle/activate

Activates a policy.

operationId: Policy_activateLifecycle

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Responses

204

No Content

POST /api/v1/policies/{policyId}/lifecycle/activate

POST /api/v1/policies/{policyId}/lifecycle/deactivate

Deactivates a policy.

operationId: Policy_deactivateLifecycle

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Responses

204

No Content

POST /api/v1/policies/{policyId}/lifecycle/deactivate

GET /api/v1/policies/{policyId}/rules

Enumerates all policy rules.

operationId: Policy_enumerateRules

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Responses

200

Success

GET /api/v1/policies/{policyId}/rules

POST /api/v1/policies/{policyId}/rules

Creates a policy rule.

operationId: Policy_createRule

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—

Request Body

application/json

schema PolicyRule

Property	Type	Required
id	string	optional
name	string	optional
type	string	optional
status	string	optional
system	boolean	optional
actions	object	optional
└ idp	object	optional
└ providers	array	optional
└ id	string	optional
└ type	string	optional
└ enroll	object	optional
└ self	string	optional
└ signon	object	optional
└ access	string	optional
└ session	object	optional
└ usePersistentCookie	boolean	optional
└ maxSessionIdleMinutes	integer	optional
└ maxSessionLifetimeMinutes	integer	optional
└ requireFactor	boolean	optional
└ factorLifetime	integer	optional
└ factorPromptMode	string	optional
└ rememberDeviceByDefault	boolean	optional
└ passwordChange	object	optional
└ access	string	optional
└ selfServiceUnlock	object	optional
└ access	string	optional
└ selfServicePasswordReset	object	optional
└ access	string	optional
created	string	optional
priority	integer	optional
conditions	object	optional
└ app	object	optional
└ exclude	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ include	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ apps	object	optional
└ exclude	array	optional
└ include	array	optional
└ risk	object	optional
└ behaviors	array	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ inactivity	object	optional
└ unit	string	optional
└ number	integer	optional
└ passwordExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleStatus	string	optional
└ userLifecycleAttribute	object	optional
└ attributeName	string	optional
└ matchingValue	string	optional
└ device	object	optional
└ rooted	boolean	optional
└ migrated	boolean	optional
└ platform	object	optional
└ types	array	optional
└ supportedMDMFrameworks	array	optional
└ trustLevel	string	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ people	object	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ scopes	object	optional
└ include	array	optional
└ clients	object	optional
└ include	array	optional
└ context	object	optional
└ expression	string	optional
└ network	object	optional
└ exclude	array	optional
└ include	array	optional
└ connection	string	optional
└ platform	object	optional
└ exclude	array	optional
└ os	object	optional
└ type	string	optional
└ include	array	optional
└ os	object	optional
└ type	string	optional
└ riskScore	object	optional
└ level	string	optional
└ grantTypes	object	optional
└ include	array	optional
└ userStatus	object	optional
└ value	string	optional
└ authContext	object	optional
└ authType	string	optional
└ authProvider	object	optional
└ include	array	optional
└ provider	string	optional
└ mdmEnrollment	object	optional
└ enrollment	string	optional
└ blockNonSafeAndroid	boolean	optional
└ userIdentifier	object	optional
└ type	string	optional
└ patterns	array	optional
└ value	string	optional
└ matchType	string	optional
└ attribute	string	optional
└ identityProvider	object	optional
└ idpIds	array	optional
└ provider	string	optional
└ …1 more	object	optional
lastUpdated	string	optional

Responses

200

Success

POST /api/v1/policies/{policyId}/rules

DELETE /api/v1/policies/{policyId}/rules/{ruleId}

Removes a policy rule.

operationId: Policy_removeRule

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

204

No Content

DELETE /api/v1/policies/{policyId}/rules/{ruleId}

GET /api/v1/policies/{policyId}/rules/{ruleId}

Gets a policy rule.

operationId: Policy_getPolicyRule

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

200

Success

GET /api/v1/policies/{policyId}/rules/{ruleId}

PUT /api/v1/policies/{policyId}/rules/{ruleId}

Updates a policy rule.

operationId: Policy_updateRule

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Request Body

application/json

schema PolicyRule

Property	Type	Required
id	string	optional
name	string	optional
type	string	optional
status	string	optional
system	boolean	optional
actions	object	optional
└ idp	object	optional
└ providers	array	optional
└ id	string	optional
└ type	string	optional
└ enroll	object	optional
└ self	string	optional
└ signon	object	optional
└ access	string	optional
└ session	object	optional
└ usePersistentCookie	boolean	optional
└ maxSessionIdleMinutes	integer	optional
└ maxSessionLifetimeMinutes	integer	optional
└ requireFactor	boolean	optional
└ factorLifetime	integer	optional
└ factorPromptMode	string	optional
└ rememberDeviceByDefault	boolean	optional
└ passwordChange	object	optional
└ access	string	optional
└ selfServiceUnlock	object	optional
└ access	string	optional
└ selfServicePasswordReset	object	optional
└ access	string	optional
created	string	optional
priority	integer	optional
conditions	object	optional
└ app	object	optional
└ exclude	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ include	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ apps	object	optional
└ exclude	array	optional
└ include	array	optional
└ risk	object	optional
└ behaviors	array	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ inactivity	object	optional
└ unit	string	optional
└ number	integer	optional
└ passwordExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleExpiration	object	optional
└ unit	string	optional
└ number	integer	optional
└ lifecycleStatus	string	optional
└ userLifecycleAttribute	object	optional
└ attributeName	string	optional
└ matchingValue	string	optional
└ device	object	optional
└ rooted	boolean	optional
└ migrated	boolean	optional
└ platform	object	optional
└ types	array	optional
└ supportedMDMFrameworks	array	optional
└ trustLevel	string	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ people	object	optional
└ users	object	optional
└ exclude	array	optional
└ include	array	optional
└ groups	object	optional
└ exclude	array	optional
└ include	array	optional
└ scopes	object	optional
└ include	array	optional
└ clients	object	optional
└ include	array	optional
└ context	object	optional
└ expression	string	optional
└ network	object	optional
└ exclude	array	optional
└ include	array	optional
└ connection	string	optional
└ platform	object	optional
└ exclude	array	optional
└ os	object	optional
└ type	string	optional
└ include	array	optional
└ os	object	optional
└ type	string	optional
└ riskScore	object	optional
└ level	string	optional
└ grantTypes	object	optional
└ include	array	optional
└ userStatus	object	optional
└ value	string	optional
└ authContext	object	optional
└ authType	string	optional
└ authProvider	object	optional
└ include	array	optional
└ provider	string	optional
└ mdmEnrollment	object	optional
└ enrollment	string	optional
└ blockNonSafeAndroid	boolean	optional
└ userIdentifier	object	optional
└ type	string	optional
└ patterns	array	optional
└ value	string	optional
└ matchType	string	optional
└ attribute	string	optional
└ identityProvider	object	optional
└ idpIds	array	optional
└ provider	string	optional
└ …1 more	object	optional
lastUpdated	string	optional

Responses

200

Success

PUT /api/v1/policies/{policyId}/rules/{ruleId}

POST /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate

Activates a policy rule.

operationId: Policy_activateRuleLifecycle

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

200

Success

POST /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate

POST /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate

Deactivates a policy rule.

operationId: Policy_deactivateRuleLifecycle

Parameters

Name	In	Required	Type	Description
policyId	path	required	string	—
ruleId	path	required	string	—

Responses

204

No Content

POST /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate

Profilemapping 3 endpoints

GET /api/v1/mappings

Enumerates Profile Mappings in your organization with pagination.

operationId: ProfileMapping_listWithPagination

Parameters

Name	In	Required	Type	Description
after	query	optional	string	—
limit	query	optional	integer	—
sourceId	query	optional	string	—
targetId	query	optional	string	—

Responses

200

Success

GET /api/v1/mappings

GET /api/v1/mappings/{mappingId} Get Profile Mapping

Fetches a single Profile Mapping referenced by its ID.

operationId: ProfileMapping_getById

Parameters

Name	In	Required	Type	Description
mappingId	path	required	string	—

Responses

200

Success

GET /api/v1/mappings/{mappingId}

POST /api/v1/mappings/{mappingId} Update Profile Mapping

Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.

operationId: ProfileMapping_updatePropertyMappings

Parameters

Name	In	Required	Type	Description
mappingId	path	required	string	—

Request Body

required

application/json

schema ProfileMapping

Property	Type	Required
id	string	optional
_links	object	optional
source	object	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ _links	object	optional
target	object	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ _links	object	optional
properties	object	optional

Responses

200

Success

POST /api/v1/mappings/{mappingId}

Session 4 endpoints

POST /api/v1/sessions Create Session with Session Token

Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

operationId: Session_createSessionWithToken

Request Body

required

application/json

schema CreateSessionRequest

Property	Type	Required
sessionToken	string	optional

Responses

200

Success

400

Bad Request

POST /api/v1/sessions

DELETE /api/v1/sessions/{sessionId} Close Session

operationId: Session_close

Parameters

Name	In	Required	Type	Description
sessionId	path	required	string	—

Responses

204

No Content

400

Bad Request

404

Not Found

DELETE /api/v1/sessions/{sessionId}

GET /api/v1/sessions/{sessionId}

Get details about a session.

operationId: Session_getDetails

Parameters

Name	In	Required	Type	Description
sessionId	path	required	string	—

Responses

200

Success

GET /api/v1/sessions/{sessionId}

POST /api/v1/sessions/{sessionId}/lifecycle/refresh Refresh Session

operationId: Session_refreshLifecycle

Parameters

Name	In	Required	Type	Description
sessionId	path	required	string	—

Responses

200

Success

404

Not Found

POST /api/v1/sessions/{sessionId}/lifecycle/refresh

Subscription 1 endpoints

GET /api/v1/roles/{roleTypeOrRoleId}/subscriptions List all subscriptions of a Custom Role

When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

operationId: Subscription_listRoleSubscriptions

Parameters

Name	In	Required	Type	Description
roleTypeOrRoleId	path	required	string	—

Responses

200

Success

404

Not Found

GET /api/v1/roles/{roleTypeOrRoleId}/subscriptions