openapi.city
Sign in

Okta API

Identity and access management

developer.okta.com/docs/reference ↗
Version
2.16.0
OpenAPI
3.0.0
Endpoints
341
Schemas
532
91
Quality
Updated
3 days ago
Identity identity authentication security
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://your-subdomain.okta.com

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Application 4 endpoints

PUT /api/v1/apps/{appId}

Updates an application in your organization.

operationId: Application_updateApplicationInOrg

Parameters

Name In Required Type Description
appId path required string —

Request Body

application/json
schema Application
Property Type Required
id string optional
name string optional
label string optional
_links object optional
status string optional
created string optional
profile object optional
features array optional
settings object optional
└ app object optional
└ url string optional
└ acsUrl string optional
└ orgName string optional
└ buttonField string optional
└ loginUrlRegex string optional
└ passwordField string optional
└ usernameField string optional
└ notes object optional
└ admin string optional
└ enduser string optional
└ inlineHookId string optional
└ notifications object optional
└ vpn object optional
└ helpUrl string optional
└ message string optional
└ network object optional
└ implicitAssignment boolean optional
_embedded object optional
licensing object optional
└ seatCount integer optional
signOnMode string optional
visibility object optional
└ hide object optional
└ iOS boolean optional
└ web boolean optional
└ appLinks object optional
└ autoLaunch boolean optional
└ autoSubmitToolbar boolean optional
credentials object optional
└ signing object optional
└ kid string optional
└ use string optional
└ lastRotated string optional
└ nextRotation string optional
└ rotationMode string optional
└ userNameTemplate object optional
└ type string optional
└ suffix string optional
└ template string optional
└ pushStatus string optional
lastUpdated string optional
accessibility object optional
└ selfService boolean optional
└ errorRedirectUrl string optional
└ loginRedirectUrl string optional

Responses

200

Success
PUT /api/v1/apps/{appId}
PUT /api/v1/apps/{appId}/features/{name}

Updates a Feature object for an application.

operationId: Application_updateFeature

Parameters

Name In Required Type Description
appId path required string —
name path required string —

Request Body

required
application/json
schema CapabilitiesObject
Property Type Required
create object optional
└ lifecycleCreate object optional
└ status string optional
update object optional
└ profile object optional
└ status string optional
└ password object optional
└ seed string optional
└ change string optional
└ status string optional
└ lifecycleDeactivate object optional
└ status string optional

Responses

200

Success
404

Not Found
PUT /api/v1/apps/{appId}/features/{name}
PUT /api/v1/apps/{appId}/groups/{groupId}

Assigns a group to an application

operationId: Application_assignGroupTo

Parameters

Name In Required Type Description
appId path required string —
groupId path required string —

Request Body

application/json
schema ApplicationGroupAssignment
Property Type Required
id string optional
_links object optional
profile object optional
priority integer optional
_embedded object optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/apps/{appId}/groups/{groupId}
PUT /api/v1/apps/{appId}/policies/{policyId}

Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

operationId: Application_assignPolicyToApplication

Parameters

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

Responses

204

No Content
PUT /api/v1/apps/{appId}/policies/{policyId}

Authenticator 1 endpoints

PUT /api/v1/authenticators/{authenticatorId}

Updates an authenticator

operationId: Authenticator_updateAuthenticator

Parameters

Name In Required Type Description
authenticatorId path required string —

Request Body

application/json
schema Authenticator
Property Type Required
id string optional
key string optional
name string optional
type string optional
_links object optional
status string optional
created string optional
provider object optional
└ type string optional
└ configuration object optional
└ host string optional
└ authPort integer optional
└ hostName string optional
└ secretKey string optional
└ instanceId string optional
└ sharedSecret string optional
└ integrationKey string optional
└ userNameTemplate object optional
└ template string optional
settings object optional
└ allowedFor string optional
└ compliance object optional
└ fips string optional
└ appInstanceId string optional
└ channelBinding object optional
└ style string optional
└ required string optional
└ userVerification string optional
└ tokenLifetimeInMinutes integer optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authenticators/{authenticatorId}

Authorizationserver 5 endpoints

PUT /api/v1/authorizationServers/{authServerId}

Success

operationId: AuthorizationServer_updateById

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

application/json
schema AuthorizationServer
Property Type Required
id string optional
name string optional
_links object optional
issuer string optional
status string optional
created string optional
default boolean optional
audiences array optional
issuerMode string optional
credentials object optional
└ signing object optional
└ kid string optional
└ use string optional
└ lastRotated string optional
└ nextRotation string optional
└ rotationMode string optional
description string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}
PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Success

operationId: AuthorizationServer_updateClaimSuccess

Parameters

Name In Required Type Description
authServerId path required string —
claimId path required string —

Request Body

application/json
schema OAuth2Claim
Property Type Required
id string optional
name string optional
value string optional
_links object optional
status string optional
system boolean optional
claimType string optional
valueType string optional
conditions object optional
└ scopes array optional
group_filter_type string optional
alwaysIncludeInToken boolean optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}

Success

operationId: AuthorizationServer_updatePolicySuccess

Parameters

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

Request Body

application/json
schema AuthorizationServerPolicy
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/authorizationServers/{authServerId}/policies/{policyId}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_updatePolicyRuleConfiguration

Parameters

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

Request Body

application/json
schema AuthorizationServerPolicyRule
Property Type Required
id string optional
name string optional
type string optional
status string optional
system boolean optional
actions object optional
└ token object optional
└ inlineHook object optional
└ id string optional
└ refreshTokenWindowMinutes integer optional
└ accessTokenLifetimeMinutes integer optional
└ refreshTokenLifetimeMinutes integer optional
created string optional
priority integer optional
conditions object 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
└ grantTypes object optional
└ include array optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Success

operationId: AuthorizationServer_updateScopeSuccess

Parameters

Name In Required Type Description
authServerId path required string —
scopeId path required string —

Request Body

application/json
schema OAuth2Scope
Property Type Required
id string optional
name string optional
system boolean optional
consent string optional
default boolean optional
description string optional
displayName string optional
metadataPublish string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Brand 3 endpoints

PUT /api/v1/brands/{brandId}

Updates a brand by brandId

operationId: Brand_updateByBrandId

Parameters

Name In Required Type Description
brandId path required string —

Request Body

required
application/json
schema Brand

Responses

200

Success
400

Bad Request
PUT /api/v1/brands/{brandId}
PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}

Update an email customization

operationId: Brand_updateEmailCustomization

Parameters

Name In Required Type Description
brandId path required string —
templateName path required string —
customizationId path required string —

Request Body

application/json
schema EmailTemplateCustomizationRequest

Responses

200

Success
409

Conflict
PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}
PUT /api/v1/brands/{brandId}/themes/{themeId}

Updates a theme for a brand

operationId: Brand_updateTheme

Parameters

Name In Required Type Description
brandId path required string —
themeId path required string —

Request Body

required
application/json
schema Theme

Responses

200

Success
400

Bad Request
404

Not Found
PUT /api/v1/brands/{brandId}/themes/{themeId}

Domain 1 endpoints

PUT /api/v1/domains/{domainId}/certificate

Creates the Certificate for the Domain.

operationId: Domain_createCertificate

Parameters

Name In Required Type Description
domainId path required string —

Request Body

required
application/json
schema DomainCertificate

Responses

204

No Content
PUT /api/v1/domains/{domainId}/certificate

Eventhook 1 endpoints

PUT /api/v1/eventHooks/{eventHookId}

Success

operationId: EventHook_updateSuccessEvent

Parameters

Name In Required Type Description
eventHookId path required string —

Request Body

application/json
schema EventHook
Property Type Required
id string optional
name string optional
_links object optional
events object optional
└ type string optional
└ items array optional
status string optional
channel object optional
└ type string optional
└ config object optional
└ uri string optional
└ headers array optional
└ key string optional
└ value string optional
└ authScheme object optional
└ key string optional
└ type string optional
└ value string optional
└ version string optional
created string optional
createdBy string optional
lastUpdated string optional
verificationStatus string optional

Responses

200

Success
PUT /api/v1/eventHooks/{eventHookId}

Group 6 endpoints

PUT /api/v1/groups/rules/{ruleId}

Updates a group rule. Only INACTIVE rules can be updated.

operationId: Group_updateRule

Parameters

Name In Required Type Description
ruleId path required string —

Request Body

application/json
schema GroupRule
Property Type Required
id string optional
name string optional
type string optional
status string optional
actions object optional
└ assignUserToGroups object optional
└ groupIds array optional
created string optional
conditions object optional
└ people object optional
└ users object optional
└ exclude array optional
└ include array optional
└ groups object optional
└ exclude array optional
└ include array optional
└ expression object optional
└ type string optional
└ value string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/groups/rules/{ruleId}
PUT /api/v1/groups/{groupId}

Updates the profile for a group with OKTA_GROUP type from your organization.

operationId: Group_updateProfile

Parameters

Name In Required Type Description
groupId path required string —

Request Body

application/json
schema Group
Property Type Required
id string optional
type string optional
_links object optional
created string optional
profile object optional
└ name string optional
└ description string optional
_embedded object optional
lastUpdated string optional
objectClass array optional
lastMembershipUpdated string optional

Responses

200

Success
PUT /api/v1/groups/{groupId}
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}

Success

operationId: Group_updateRolesCatalogApps

Parameters

Name In Required Type Description
groupId path required string —
roleId path required string —
appName path required string —

Responses

200

Success
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}

Add App Instance Target to App Administrator Role given to a Group

operationId: Group_addAppInstanceTargetToAppAdminRoleGivenToGroup

Parameters

Name In Required Type Description
groupId path required string —
roleId path required string —
appName path required string —
applicationId path required string —

Responses

204

No Content
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
operationId: Group_updateTargetGroupsRole

Parameters

Name In Required Type Description
groupId path required string —
roleId path required string —
targetGroupId path required string —

Responses

204

No Content
PUT /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
PUT /api/v1/groups/{groupId}/users/{userId}

Adds a user to a group with ‘OKTA_GROUP’ type.

operationId: Group_addUserToGroup

Parameters

Name In Required Type Description
groupId path required string —
userId path required string —

Responses

204

No Content
PUT /api/v1/groups/{groupId}/users/{userId}

Identityprovider 1 endpoints

PUT /api/v1/idps/{idpId}

Updates the configuration for an IdP.

operationId: IdentityProvider_updateConfiguration

Parameters

Name In Required Type Description
idpId path required string —

Request Body

application/json
schema IdentityProvider
Property Type Required
id string optional
name string optional
type string optional
_links object optional
policy object optional
└ subject object optional
└ filter string optional
└ format array optional
└ matchType string optional
└ matchAttribute string optional
└ userNameTemplate object optional
└ template string optional
└ accountLink object optional
└ action string optional
└ filter object optional
└ groups object optional
└ maxClockSkew integer optional
└ provisioning object optional
└ action string optional
└ groups object optional
└ action string optional
└ filter array optional
└ assignments array optional
└ sourceAttributeName string optional
└ conditions object optional
└ suspended object optional
└ deprovisioned object optional
└ profileMaster boolean optional
status string optional
created string optional
protocol object optional
└ type string optional
└ issuer object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ scopes array optional
└ settings object optional
└ nameFormat string optional
└ endpoints object optional
└ acs object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ slo object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ sso object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ jwks object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ token object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ metadata object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ userInfo object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ authorization object optional
└ url string optional
└ type string optional
└ binding string optional
└ destination string optional
└ algorithms object optional
└ request object optional
└ signature object optional
└ response object optional
└ signature object optional
└ relayState object optional
└ format string optional
└ credentials object optional
└ trust object optional
└ kid string optional
└ issuer string optional
└ audience string optional
└ revocation string optional
└ revocationCacheLifetime integer optional
└ client object optional
└ client_id string optional
└ client_secret string optional
└ signing object optional
└ kid string optional
└ teamId string optional
└ privateKey string optional
issuerMode string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/idps/{idpId}

Inlinehook 1 endpoints

PUT /api/v1/inlineHooks/{inlineHookId}

Updates an inline hook by ID

operationId: InlineHook_updateById

Parameters

Name In Required Type Description
inlineHookId path required string —

Request Body

application/json
schema InlineHook
Property Type Required
id string optional
name string optional
type string optional
_links object optional
status string optional
channel object optional
└ type string optional
└ config object optional
└ uri string optional
└ method string optional
└ headers array optional
└ key string optional
└ value string optional
└ authScheme object optional
└ key string optional
└ type string optional
└ value string optional
└ version string optional
created string optional
version string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/inlineHooks/{inlineHookId}

Networkzone 1 endpoints

PUT /api/v1/zones/{zoneId}

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}

Org 2 endpoints

PUT /api/v1/org

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
PUT /api/v1/org/contacts/{contactType}

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}

Policy 2 endpoints

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}
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}

Template 1 endpoints

PUT /api/v1/templates/sms/{templateId}

Updates the SMS template.

operationId: Template_updateSmsTemplate

Parameters

Name In Required Type Description
templateId path required string —

Request Body

application/json
schema SmsTemplate
Property Type Required
id string optional
name string optional
type string optional
created string optional
template string optional
lastUpdated string optional
translations object optional

Responses

200

Success
PUT /api/v1/templates/sms/{templateId}

Trustedorigin 1 endpoints

PUT /api/v1/trustedOrigins/{trustedOriginId}

Success

operationId: TrustedOrigin_updateSuccess

Parameters

Name In Required Type Description
trustedOriginId path required string —

Request Body

application/json
schema TrustedOrigin
Property Type Required
id string optional
name string optional
_links object optional
origin string optional
scopes array optional
└ type string optional
└ stringValue string optional
└ allowedOktaApps array optional
status string optional
created string optional
createdBy string optional
lastUpdated string optional
lastUpdatedBy string optional

Responses

200

Success
PUT /api/v1/trustedOrigins/{trustedOriginId}

User 6 endpoints

PUT /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}
operationId: User_updateLinkedObject

Parameters

Name In Required Type Description
associatedUserId path required string —
primaryRelationshipName path required string —
primaryUserId path required string —

Responses

204

Success
PUT /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}
PUT /api/v1/users/{userId}

Update a user’s profile and/or credentials using strict-update semantics.

operationId: User_updateProfile

Parameters

Name In Required Type Description
userId path required string —
strict query optional boolean —

Request Body

application/json
schema User
Property Type Required
id string optional
type object optional
└ id string optional
└ name string optional
└ _links object optional
└ created string optional
└ default boolean optional
└ createdBy string optional
└ description string optional
└ displayName string optional
└ lastUpdated string optional
└ lastUpdatedBy string optional
_links object optional
status string optional
created string optional
profile object optional
└ city string optional
└ email string optional
└ login string optional
└ state string optional
└ title string optional
└ locale string optional
└ manager string optional
└ zipCode string optional
└ division string optional
└ lastName string optional
└ nickName string optional
└ timezone string optional
└ userType string optional
└ firstName string optional
└ managerId string optional
└ costCenter string optional
└ department string optional
└ middleName string optional
└ profileUrl string optional
└ countryCode string optional
└ …11 more object optional
_embedded object optional
activated string optional
lastLogin string optional
credentials object optional
└ password object optional
└ hash object optional
└ salt string optional
└ value string optional
└ algorithm string optional
└ saltOrder string optional
└ workFactor integer optional
└ hook object optional
└ type string optional
└ value string optional
└ provider object optional
└ name string optional
└ type string optional
└ recovery_question object optional
└ answer string optional
└ question string optional
lastUpdated string optional
statusChanged string optional
passwordChanged string optional
transitioningToStatus string optional

Responses

200

Success
PUT /api/v1/users/{userId}
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps

Success

operationId: User_updateRolesCatalogApps

Parameters

Name In Required Type Description
userId path required string —
roleId path required string —

Responses

200

Success
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}

Success

operationId: User_updateRolesCatalogApps

Parameters

Name In Required Type Description
userId path required string —
roleId path required string —
appName path required string —

Responses

200

Success
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}

Add App Instance Target to App Administrator Role given to a User

operationId: User_addAppInstanceTargetToAppAdministratorRoleGivenToUser

Parameters

Name In Required Type Description
userId path required string —
roleId path required string —
appName path required string —
applicationId path required string —

Responses

204

No Content
PUT /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
PUT /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}

Success

operationId: User_updateRolesCatalogApps

Parameters

Name In Required Type Description
userId path required string —
roleId path required string —
groupId path required string —

Responses

200

Success
PUT /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}

Usertype 1 endpoints

PUT /api/v1/meta/types/user/{typeId}

Replace an existing User Type

operationId: UserType_replaceExistingType

Parameters

Name In Required Type Description
typeId path required string —

Request Body

application/json
schema UserType
Property Type Required
id string optional
name string optional
_links object optional
created string optional
default boolean optional
createdBy string optional
description string optional
displayName string optional
lastUpdated string optional
lastUpdatedBy string optional

Responses

200

Success
PUT /api/v1/meta/types/user/{typeId}
Load more endpoints

Schemas

object AccessPolicy 
{
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/Policy"
}
object AccessPolicyConstraint 
{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "methods": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "reauthenticateIn": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AccessPolicyConstraints 
{
  "type": "object",
  "properties": {
    "knowledge": {
      "$ref": "#/components/schemas/KnowledgeConstraint"
    },
    "possession": {
      "$ref": "#/components/schemas/PossessionConstraint"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AccessPolicyRule 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "actions": {
      "$ref": "#/components/schemas/AccessPolicyRuleActions"
    },
    "conditions": {
      "$ref": "#/components/schemas/AccessPolicyRuleConditions"
    }
  },
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/PolicyRule"
}
object AccessPolicyRuleActions 
{
  "type": "object",
  "properties": {
    "appSignOn": {
      "$ref": "#/components/schemas/AccessPolicyRuleApplicationSignOn"
    }
  },
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/PolicyRuleActions"
}
object AccessPolicyRuleApplicationSignOn 
{
  "type": "object",
  "properties": {
    "access": {
      "type": "string"
    },
    "verificationMethod": {
      "$ref": "#/components/schemas/VerificationMethod"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AccessPolicyRuleConditions 
{
  "properties": {
    "device": {
      "$ref": "#/components/schemas/DeviceAccessPolicyRuleCondition"
    },
    "userType": {
      "$ref": "#/components/schemas/UserTypeCondition"
    },
    "elCondition": {
      "$ref": "#/components/schemas/AccessPolicyRuleCustomCondition"
    }
  },
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/PolicyRuleConditions"
}
object AccessPolicyRuleCustomCondition 
{
  "properties": {
    "condition": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AcsEndpoint 
{
  "properties": {
    "url": {
      "type": "string"
    },
    "index": {
      "type": "integer"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ActivateFactorRequest 
{
  "properties": {
    "passCode": {
      "type": "string"
    },
    "clientData": {
      "type": "string"
    },
    "stateToken": {
      "type": "string"
    },
    "attestation": {
      "type": "string"
    },
    "registrationData": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}
string AllowedForEnum 
{
  "enum": [
    "recovery",
    "sso",
    "any",
    "none"
  ],
  "type": "string",
  "x-okta-tags": [
    "Authenticator"
  ]
}
object AppAndInstanceConditionEvaluatorAppOrInstance 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "enum": [
        "APP_TYPE",
        "APP"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AppAndInstancePolicyRuleCondition 
{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AppInstancePolicyRuleCondition 
{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}
object AppLink 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "label": {
      "type": "string",
      "readOnly": true
    },
    "hidden": {
      "type": "boolean",
      "readOnly": true
    },
    "appName": {
      "type": "string",
      "readOnly": true
    },
    "linkUrl": {
      "type": "string",
      "readOnly": true
    },
    "logoUrl": {
      "type": "string",
      "readOnly": true
    },
    "sortOrder": {
      "type": "integer",
      "readOnly": true
    },
    "appInstanceId": {
      "type": "string",
      "readOnly": true
    },
    "appAssignmentId": {
      "type": "string",
      "readOnly": true
    },
    "credentialsSetup": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "User"
  ]
}
object AppUser 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "scope": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "type": "string",
      "readOnly": true
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "profile": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "lastSync": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "syncState": {
      "type": "string",
      "readOnly": true
    },
    "externalId": {
      "type": "string",
      "readOnly": true
    },
    "credentials": {
      "$ref": "#/components/schemas/AppUserCredentials"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "statusChanged": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "passwordChanged": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "update",
      "arguments": [
        {
          "dest": "appId",
          "parentSrc": "appId"
        },
        {
          "src": "id",
          "dest": "userId"
        },
        {
          "dest": "appUser",
          "self": true
        }
      ],
      "operationId": "updateApplicationUser"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "dest": "appId",
          "parentSrc": "appId"
        },
        {
          "src": "id",
          "dest": "userId"
        }
      ],
      "operationId": "deleteApplicationUser"
    }
  ],
  "x-okta-tags": [
    "Application"
  ]
}
object AppUserCredentials 
{
  "type": "object",
  "properties": {
    "password": {
      "$ref": "#/components/schemas/AppUserPasswordCredential"
    },
    "userName": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object AppUserPasswordCredential 
{
  "properties": {
    "value": {
      "type": "string",
      "format": "password"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object Application 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "label": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "DELETED"
      ],
      "type": "string",
      "readOnly": true
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "profile": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "settings": {
      "$ref": "#/components/schemas/ApplicationSettings"
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "licensing": {
      "$ref": "#/components/schemas/ApplicationLicensing"
    },
    "signOnMode": {
      "$ref": "#/components/schemas/ApplicationSignOnMode"
    },
    "visibility": {
      "$ref": "#/components/schemas/ApplicationVisibility"
    },
    "credentials": {
      "$ref": "#/components/schemas/ApplicationCredentials"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "accessibility": {
      "$ref": "#/components/schemas/ApplicationAccessibility"
    }
  },
  "x-okta-crud": [
    {
      "alias": "read",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getApplication"
    },
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        },
        {
          "dest": "application",
          "self": true
        }
      ],
      "operationId": "updateApplication"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "deleteApplication"
    }
  ],
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-operations": [
    {
      "alias": "activate",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "activateApplication"
    },
    {
      "alias": "deactivate",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "deactivateApplication"
    },
    {
      "alias": "listApplicationUsers",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listApplicationUsers"
    },
    {
      "alias": "assignUserToApplication",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "assignUserToApplication"
    },
    {
      "alias": "getApplicationUser",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getApplicationUser"
    },
    {
      "alias": "createApplicationGroupAssignment",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "createApplicationGroupAssignment"
    },
    {
      "alias": "getApplicationGroupAssignment",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getApplicationGroupAssignment"
    },
    {
      "alias": "cloneApplicationKey",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "cloneApplicationKey"
    },
    {
      "alias": "getApplicationKey",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getApplicationKey"
    },
    {
      "alias": "listGroupAssignments",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listApplicationGroupAssignments"
    },
    {
      "alias": "listKeys",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listApplicationKeys"
    },
    {
      "alias": "generateKey",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "generateApplicationKey"
    },
    {
      "alias": "generateCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "generateCsrForApplication"
    },
    {
      "alias": "getCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getCsrForApplication"
    },
    {
      "alias": "revokeCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "revokeCsrFromApplication"
    },
    {
      "alias": "listCsrs",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listCsrsForApplication"
    },
    {
      "alias": "publishCerCert",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "publishCerCert"
    },
    {
      "alias": "publishBinaryCerCert",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "publishBinaryCerCert"
    },
    {
      "alias": "publishDerCert",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "publishDerCert"
    },
    {
      "alias": "publishBinaryDerCert",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "publishBinaryDerCert"
    },
    {
      "alias": "publishBinaryPemCert",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "publishBinaryPemCert"
    },
    {
      "alias": "listOAuth2Tokens",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listOAuth2TokensForApplication"
    },
    {
      "alias": "revokeOAuth2TokenForApplication",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "revokeOAuth2TokenForApplication"
    },
    {
      "alias": "getOAuth2Token",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getOAuth2TokenForApplication"
    },
    {
      "alias": "revokeOAuth2Tokens",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "revokeOAuth2TokensForApplication"
    },
    {
      "alias": "listScopeConsentGrants",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "listScopeConsentGrants"
    },
    {
      "alias": "grantConsentToScope",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "grantConsentToScope"
    },
    {
      "alias": "revokeScopeConsentGrant",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "revokeScopeConsentGrant"
    },
    {
      "alias": "getScopeConsentGrant",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getScopeConsentGrant"
    },
    {
      "alias": "uploadApplicationLogo",
      "operationId": "uploadApplicationLogo"
    },
    {
      "alias": "getFeatureForApplication",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "getFeatureForApplication"
    },
    {
      "alias": "updateFeatureForApplication",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "updateFeatureForApplication"
    },
    {
      "alias": "updateApplicationPolicy",
      "arguments": [
        {
          "src": "id",
          "dest": "appId"
        }
      ],
      "operationId": "updateApplicationPolicy"
    }
  ],
  "x-openapi-v3-discriminator": {
    "mapping": {
      "BOOKMARK": "#/definitions/BookmarkApplication",
      "SAML_1_1": "#/definitions/SamlApplication",
      "SAML_2_0": "#/definitions/SamlApplication",
      "AUTO_LOGIN": "#/definitions/AutoLoginApplication",
      "BASIC_AUTH": "#/definitions/BasicAuthApplication",
      "WS_FEDERATION": "#/definitions/WsFederationApplication",
      "BROWSER_PLUGIN": "#/definitions/BrowserPluginApplication",
      "OPENID_CONNECT": "#/definitions/OpenIdConnectApplication",
      "SECURE_PASSWORD_STORE": "#/definitions/SecurePasswordStoreApplication"
    },
    "propertyName": "signOnMode"
  }
}
object ApplicationAccessibility 
{
  "type": "object",
  "properties": {
    "selfService": {
      "type": "boolean"
    },
    "errorRedirectUrl": {
      "type": "string"
    },
    "loginRedirectUrl": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationCredentials 
{
  "type": "object",
  "properties": {
    "signing": {
      "$ref": "#/components/schemas/ApplicationCredentialsSigning"
    },
    "userNameTemplate": {
      "$ref": "#/components/schemas/ApplicationCredentialsUsernameTemplate"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationCredentialsOAuthClient 
{
  "properties": {
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "pkce_required": {
      "type": "boolean"
    },
    "autoKeyRotation": {
      "type": "boolean"
    },
    "token_endpoint_auth_method": {
      "$ref": "#/components/schemas/OAuthEndpointAuthenticationMethod"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
string ApplicationCredentialsScheme 
{
  "enum": [
    "SHARED_USERNAME_AND_PASSWORD",
    "EXTERNAL_PASSWORD_SYNC",
    "EDIT_USERNAME_AND_PASSWORD",
    "EDIT_PASSWORD_ONLY",
    "ADMIN_SETS_CREDENTIALS"
  ],
  "type": "string",
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationCredentialsSigning 
{
  "type": "object",
  "properties": {
    "kid": {
      "type": "string"
    },
    "use": {
      "$ref": "#/components/schemas/ApplicationCredentialsSigningUse"
    },
    "lastRotated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "nextRotation": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "rotationMode": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
string ApplicationCredentialsSigningUse 
{
  "enum": [
    "sig"
  ],
  "type": "string",
  "x-okta-tags": [
    "AuthorizationServer"
  ]
}
object ApplicationCredentialsUsernameTemplate 
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "suffix": {
      "type": "string"
    },
    "template": {
      "type": "string"
    },
    "pushStatus": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationFeature 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "$ref": "#/components/schemas/EnabledStatus"
    },
    "description": {
      "type": "string"
    },
    "capabilities": {
      "$ref": "#/components/schemas/CapabilitiesObject"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-operations": [
    {
      "alias": "listFeaturesForApplication",
      "operationId": "listFeaturesForApplication"
    }
  ]
}
object ApplicationGroupAssignment 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "profile": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "priority": {
      "type": "integer"
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "delete",
      "arguments": [
        {
          "dest": "appId",
          "parentSrc": "appId"
        },
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "deleteApplicationGroupAssignment"
    }
  ],
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationLicensing 
{
  "type": "object",
  "properties": {
    "seatCount": {
      "type": "integer"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
array ApplicationListAppsResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Application"
  }
}
array ApplicationListAssignedUsersResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppUser"
  }
}
array ApplicationListClientSecretsResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ClientSecret"
  }
}
array ApplicationListCsrsForApplicationResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Csr"
  }
}
array ApplicationListFeaturesResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ApplicationFeature"
  }
}
array ApplicationListGroupsAssignedResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ApplicationGroupAssignment"
  }
}
array ApplicationListKeyCredentialsResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/JsonWebKey"
  }
}
array ApplicationListScopeConsentGrantsResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
  }
}
array ApplicationListTokensResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OAuth2Token"
  }
}
object ApplicationPreviewSamlAppMetadataResponse 
{
  "type": "object",
  "properties": {
    "EntityDescriptor": {
      "type": "object",
      "properties": {
        "entityID": {
          "xml": {
            "attribute": true
          },
          "type": "string"
        },
        "IDPSSODescriptor": {
          "type": "object",
          "properties": {
            "NameIDFormat": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "KeyDescriptor": {
              "type": "object",
              "properties": {
                "use": {
                  "xml": {
                    "attribute": true
                  },
                  "type": "string"
                },
                "KeyInfo": {
                  "type": "object",
                  "properties": {
                    "X509Data": {
                      "type": "object",
                      "properties": {
                        "X509Certificate": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            },
            "SingleLogoutService": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "properties": {
                "Binding": {
                  "xml": {
                    "attribute": true
                  },
                  "type": "string"
                },
                "Location": {
                  "xml": {
                    "attribute": true
                  },
                  "type": "string"
                }
              }
            },
            "SingleSignOnService": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "properties": {
                "Binding": {
                  "xml": {
                    "attribute": true
                  },
                  "type": "string"
                },
                "Location": {
                  "xml": {
                    "attribute": true
                  },
                  "type": "string"
                }
              }
            },
            "WantAuthnRequestsSigned": {
              "xml": {
                "attribute": true
              },
              "type": "boolean"
            },
            "protocolSupportEnumeration": {
              "xml": {
                "attribute": true
              },
              "type": "string"
            }
          }
        }
      }
    }
  }
}
object ApplicationSettings 
{
  "type": "object",
  "properties": {
    "app": {
      "$ref": "#/components/schemas/ApplicationSettingsApplication"
    },
    "notes": {
      "$ref": "#/components/schemas/ApplicationSettingsNotes"
    },
    "inlineHookId": {
      "type": "string"
    },
    "notifications": {
      "$ref": "#/components/schemas/ApplicationSettingsNotifications"
    },
    "implicitAssignment": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationSettingsApplication 
{
  "properties": {
    "url": {
      "type": "string"
    },
    "acsUrl": {
      "type": "string"
    },
    "orgName": {
      "type": "string"
    },
    "buttonField": {
      "type": "string"
    },
    "loginUrlRegex": {
      "type": "string"
    },
    "passwordField": {
      "type": "string"
    },
    "usernameField": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationSettingsNotes 
{
  "type": "object",
  "properties": {
    "admin": {
      "type": "string"
    },
    "enduser": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationSettingsNotifications 
{
  "type": "object",
  "properties": {
    "vpn": {
      "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpn"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationSettingsNotificationsVpn 
{
  "type": "object",
  "properties": {
    "helpUrl": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "network": {
      "$ref": "#/components/schemas/ApplicationSettingsNotificationsVpnNetwork"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationSettingsNotificationsVpnNetwork 
{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "connection": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
string ApplicationSignOnMode 
{
  "enum": [
    "BOOKMARK",
    "BASIC_AUTH",
    "BROWSER_PLUGIN",
    "SECURE_PASSWORD_STORE",
    "AUTO_LOGIN",
    "WS_FEDERATION",
    "SAML_2_0",
    "OPENID_CONNECT",
    "SAML_1_1"
  ],
  "type": "string",
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationUpdateLogoRequest 
{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary"
    }
  }
}
object ApplicationVisibility 
{
  "type": "object",
  "properties": {
    "hide": {
      "$ref": "#/components/schemas/ApplicationVisibilityHide"
    },
    "appLinks": {
      "type": "object",
      "additionalProperties": {
        "type": "boolean"
      }
    },
    "autoLaunch": {
      "type": "boolean"
    },
    "autoSubmitToolbar": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object ApplicationVisibilityHide 
{
  "type": "object",
  "properties": {
    "iOS": {
      "type": "boolean"
    },
    "web": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}
object AssignRoleRequest 
{
  "properties": {
    "type": {
      "$ref": "#/components/schemas/RoleType"
    }
  },
  "x-okta-tags": [
    "Role"
  ]
}
Load more schemas

Versions

Version Endpoints Schemas Ingested Status
2.16.0 341 532 2026-05-25 current
2.16.0 341 532 2026-04-16