SwaApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"checkbox": {
"type": "string"
},
"buttonField": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"loginUrlRegex": {
"type": "string"
},
"passwordField": {
"type": "string"
},
"usernameField": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
SwaThreeFieldApplication
{
"properties": {
"name": {
"default": "template_swa3field"
},
"settings": {
"$ref": "#/components/schemas/SwaThreeFieldApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/BrowserPluginApplication",
"x-okta-defined-as": {
"name": "template_swa3field"
}
}
SwaThreeFieldApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/SwaThreeFieldApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
SwaThreeFieldApplicationSettingsApplication
{
"properties": {
"targetURL": {
"type": "string"
},
"loginUrlRegex": {
"type": "string"
},
"buttonSelector": {
"type": "string"
},
"extraFieldValue": {
"type": "string"
},
"passwordSelector": {
"type": "string"
},
"userNameSelector": {
"type": "string"
},
"extraFieldSelector": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
TempPassword
{
"properties": {
"tempPassword": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
TemplateEnumerateSmsTemplatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SmsTemplate"
}
}
Theme
{
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"backgroundImage": {
"type": "string",
"readOnly": true
},
"primaryColorHex": {
"type": "string"
},
"secondaryColorHex": {
"type": "string"
},
"primaryColorContrastHex": {
"type": "string"
},
"secondaryColorContrastHex": {
"type": "string"
},
"errorPageTouchPointVariant": {
"$ref": "#/components/schemas/ErrorPageTouchPointVariant"
},
"signInPageTouchPointVariant": {
"$ref": "#/components/schemas/SignInPageTouchPointVariant"
},
"emailTemplateTouchPointVariant": {
"$ref": "#/components/schemas/EmailTemplateTouchPointVariant"
},
"endUserDashboardTouchPointVariant": {
"$ref": "#/components/schemas/EndUserDashboardTouchPointVariant"
}
},
"x-okta-crud": [
{
"alias": "read",
"operationId": "getBrandTheme"
},
{
"alias": "update",
"operationId": "updateBrandTheme"
}
],
"x-okta-tags": [
"Brand"
],
"x-okta-operations": [
{
"alias": "uploadBrandThemeLogo",
"operationId": "uploadBrandThemeLogo"
},
{
"alias": "deleteBrandThemeLogo",
"operationId": "deleteBrandThemeLogo"
},
{
"alias": "updateBrandThemeFavicon",
"operationId": "uploadBrandThemeFavicon"
},
{
"alias": "deleteBrandThemeFavicon",
"operationId": "deleteBrandThemeFavicon"
},
{
"alias": "updateBrandThemeBackgroundImage",
"operationId": "uploadBrandThemeBackgroundImage"
},
{
"alias": "deleteBrandThemeBackgroundImage",
"operationId": "deleteBrandThemeBackgroundImage"
}
]
}
ThemeResponse
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"logo": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"favicon": {
"type": "string",
"readOnly": true
},
"backgroundImage": {
"type": "string",
"readOnly": true
},
"primaryColorHex": {
"type": "string"
},
"secondaryColorHex": {
"type": "string"
},
"primaryColorContrastHex": {
"type": "string"
},
"secondaryColorContrastHex": {
"type": "string"
},
"errorPageTouchPointVariant": {
"$ref": "#/components/schemas/ErrorPageTouchPointVariant"
},
"signInPageTouchPointVariant": {
"$ref": "#/components/schemas/SignInPageTouchPointVariant"
},
"emailTemplateTouchPointVariant": {
"$ref": "#/components/schemas/EmailTemplateTouchPointVariant"
},
"endUserDashboardTouchPointVariant": {
"$ref": "#/components/schemas/EndUserDashboardTouchPointVariant"
}
},
"x-okta-tags": [
"Brand"
]
}
ThreatInsightConfiguration
{
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"action": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"excludeZones": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [],
"operationId": "getCurrentConfiguration"
},
{
"alias": "update",
"arguments": [
{
"dest": "threatInsightConfiguration",
"self": true
}
],
"operationId": "updateConfiguration"
}
],
"x-okta-tags": [
"ThreatInsight"
]
}
TokenAuthorizationServerPolicyRuleAction
{
"type": "object",
"properties": {
"inlineHook": {
"$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleActionInlineHook"
},
"refreshTokenWindowMinutes": {
"type": "integer"
},
"accessTokenLifetimeMinutes": {
"type": "integer"
},
"refreshTokenLifetimeMinutes": {
"type": "integer"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
TokenAuthorizationServerPolicyRuleActionInlineHook
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
TokenUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/TokenUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
TokenUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
TotpUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/TotpUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
TotpUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
TrustedOrigin
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"origin": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scope"
}
},
"status": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdatedBy": {
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "trustedOrigin",
"self": true
}
],
"operationId": "createOrigin"
},
{
"alias": "read",
"arguments": [],
"operationId": "getOrigin"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "trustedOriginId"
},
{
"dest": "trustedOrigin",
"self": true
}
],
"operationId": "updateOrigin"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "trustedOriginId"
}
],
"operationId": "deleteOrigin"
}
],
"x-okta-tags": [
"TrustedOrigin"
]
}
TrustedOriginGetListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TrustedOrigin"
}
}
U2fUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/U2fUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
U2fUserFactorProfile
{
"properties": {
"credentialId": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
User
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/UserType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/UserStatus"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"profile": {
"$ref": "#/components/schemas/UserProfile"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"activated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"credentials": {
"$ref": "#/components/schemas/UserCredentials"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"statusChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"passwordChanged": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"transitioningToStatus": {
"$ref": "#/components/schemas/UserStatus"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "user",
"self": true
}
],
"operationId": "createUser"
},
{
"alias": "read",
"arguments": [],
"operationId": "getUser"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "userId"
},
{
"dest": "user",
"self": true
}
],
"operationId": "updateUser"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "userId"
},
{
"dest": "user",
"self": true
}
],
"operationId": "deactivateOrDeleteUser"
}
],
"x-okta-tags": [
"User"
],
"x-okta-operations": [
{
"alias": "listAppLinks",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listAppLinks"
},
{
"alias": "changePassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "changePassword"
},
{
"alias": "changeRecoveryQuestion",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "changeRecoveryQuestion"
},
{
"alias": "forgotPasswordSetNewPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "forgotPasswordSetNewPassword"
},
{
"alias": "forgotPasswordGenerateOneTimeToken",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "forgotPasswordGenerateOneTimeToken"
},
{
"alias": "assignRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "assignRoleToUser"
},
{
"alias": "getRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getUserRole"
},
{
"alias": "removeRole",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeRoleFromUser"
},
{
"alias": "listGroupTargets",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listGroupTargetsForRole"
},
{
"alias": "removeGroupTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeGroupTargetFromRole"
},
{
"alias": "addGroupTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "addGroupTargetToRole"
},
{
"alias": "listAssignedRoles",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listAssignedRolesForUser"
},
{
"alias": "addAllAppsAsTarget",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "addAllAppsAsTargetToRole"
},
{
"alias": "listGroups",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserGroups"
},
{
"alias": "listGrants",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserGrants"
},
{
"alias": "revokeGrants",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeUserGrants"
},
{
"alias": "revokeGrant",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeUserGrant"
},
{
"alias": "revokeGrantsForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeGrantsForUserAndClient"
},
{
"alias": "listRefreshTokensForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listRefreshTokensForUserAndClient"
},
{
"alias": "revokeTokenForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeTokenForUserAndClient"
},
{
"alias": "getRefreshTokenForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getRefreshTokenForUserAndClient"
},
{
"alias": "revokeTokensForUserAndClient",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "revokeTokensForUserAndClient"
},
{
"alias": "listClients",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserClients"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "activateUser"
},
{
"alias": "reactivate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "reactivateUser"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "deactivateUser"
},
{
"alias": "suspend",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "suspendUser"
},
{
"alias": "unsuspend",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "unsuspendUser"
},
{
"alias": "resetPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "resetPassword"
},
{
"alias": "expirePassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "expirePassword"
},
{
"alias": "expirePasswordAndGetTemporaryPassword",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "expirePasswordAndGetTemporaryPassword"
},
{
"alias": "unlock",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "unlockUser"
},
{
"alias": "resetFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "resetFactors"
},
{
"alias": "deleteFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "deleteFactor"
},
{
"alias": "addToGroup",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"description": "Adds a user to a group with 'OKTA_GROUP' type",
"operationId": "addUserToGroup"
},
{
"alias": "enrollFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "enrollFactor"
},
{
"alias": "listSupportedFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listSupportedFactors"
},
{
"alias": "listFactors",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listFactors"
},
{
"alias": "listSupportedSecurityQuestions",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listSupportedSecurityQuestions"
},
{
"alias": "getFactor",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getFactor"
},
{
"alias": "setLinkedObject",
"arguments": [
{
"src": "id",
"dest": "associatedUserId"
}
],
"operationId": "setLinkedObjectForUser"
},
{
"alias": "listIdentityProviders",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "listUserIdentityProviders"
},
{
"alias": "getLinkedObjects",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "getLinkedObjectsForUser"
},
{
"alias": "clearSessions",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "clearUserSessions"
},
{
"alias": "removeLinkedObject",
"arguments": [
{
"src": "id",
"dest": "userId"
}
],
"operationId": "removeLinkedObjectForUser"
}
]
}
UserActivationToken
{
"type": "object",
"properties": {
"activationUrl": {
"type": "string",
"readOnly": true
},
"activationToken": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"User"
]
}
UserCondition
{
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
UserCredentials
{
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/PasswordCredential"
},
"provider": {
"$ref": "#/components/schemas/AuthenticationProvider"
},
"recovery_question": {
"$ref": "#/components/schemas/RecoveryQuestionCredential"
}
},
"x-okta-tags": [
"User"
]
}
UserFactor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/FactorStatus"
},
"verify": {
"$ref": "#/components/schemas/VerifyFactorRequest"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/FactorProvider"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"factorType": {
"$ref": "#/components/schemas/FactorType"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "deleteFactor"
}
],
"x-okta-tags": [
"UserFactor"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "activateFactor"
},
{
"alias": "verify",
"arguments": [
{
"src": "id",
"dest": "factorId"
},
{
"dest": "userId",
"parentSrc": "id"
}
],
"operationId": "verifyFactor"
}
],
"x-openapi-v3-discriminator": {
"mapping": {
"sms": "#/definitions/SmsUserFactor",
"u2f": "#/definitions/U2fUserFactor",
"web": "#/definitions/WebUserFactor",
"call": "#/definitions/CallUserFactor",
"hotp": "#/definitions/CustomHotpUserFactor",
"push": "#/definitions/PushUserFactor",
"email": "#/definitions/EmailUserFactor",
"token": "#/definitions/TokenUserFactor",
"question": "#/definitions/SecurityQuestionUserFactor",
"webauthn": "#/definitions/WebAuthnUserFactor",
"token:hotp": "#/definitions/CustomHotpUserFactor",
"token:hardware": "#/definitions/HardwareUserFactor",
"token:software:totp": "#/definitions/TotpUserFactor"
},
"propertyName": "factorType"
}
}
UserFactorEnumerateEnrolledResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserFactor"
}
}
UserFactorEnumerateSecurityQuestionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityQuestion"
}
}
UserFactorEnumerateSupportedFactorsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserFactor"
}
}
UserGetLinkedObjectsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseLinks"
}
}
UserGetMemberGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
UserIdString
{
"type": "object",
"properties": {
"userId": {
"type": "string"
}
},
"x-okta-tags": [
"Org"
],
"x-okta-parent": "#/definitions/OrgContactUser"
}
UserIdentifierConditionEvaluatorPattern
{
"type": "object",
"properties": {
"value": {
"type": "string"
},
"matchType": {
"enum": [
"SUFFIX",
"EXPRESSION",
"STARTS_WITH",
"EQUALS",
"CONTAINS"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserIdentifierPolicyRuleCondition
{
"type": "object",
"properties": {
"type": {
"enum": [
"IDENTIFIER",
"ATTRIBUTE"
],
"type": "string"
},
"patterns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserIdentifierConditionEvaluatorPattern"
}
},
"attribute": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserIdentityProviderLinkRequest
{
"type": "object",
"properties": {
"externalId": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserLifecycleAttributePolicyRuleCondition
{
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"matchingValue": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
UserListActiveUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
UserListAppTargetsForRoleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogApplication"
}
}
UserListAssignedAppLinksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AppLink"
}
}
UserListAssignedRolesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
UserListClientsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Client"
}
}
UserListGrantsForClientResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
}
}
UserListGrantsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
}
}
UserListIdpsForUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
UserListRefreshTokensForUserAndClientResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2RefreshToken"
}
}
UserListRoleTargetsGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
UserListSubscriptionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
UserNextLogin
{
"enum": [
"changePassword"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
UserPolicyRuleCondition
{
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"inactivity": {
"$ref": "#/components/schemas/InactivityPolicyRuleCondition"
},
"passwordExpiration": {
"$ref": "#/components/schemas/PasswordExpirationPolicyRuleCondition"
},
"lifecycleExpiration": {
"$ref": "#/components/schemas/LifecycleExpirationPolicyRuleCondition"
},
"userLifecycleAttribute": {
"$ref": "#/components/schemas/UserLifecycleAttributePolicyRuleCondition"
}
},
"x-okta-tags": [
"Policy"
]
}
UserProfile
{
"type": "object",
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"login": {
"type": "string"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"locale": {
"type": "string"
},
"manager": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"division": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nickName": {
"type": "string"
},
"timezone": {
"type": "string"
},
"userType": {
"type": "string"
},
"firstName": {
"type": "string"
},
"managerId": {
"type": "string"
},
"costCenter": {
"type": "string"
},
"department": {
"type": "string"
},
"middleName": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"displayName": {
"type": "string"
},
"mobilePhone": {
"type": "string"
},
"secondEmail": {
"type": "string"
},
"organization": {
"type": "string"
},
"primaryPhone": {
"type": "string"
},
"postalAddress": {
"type": "string"
},
"streetAddress": {
"type": "string"
},
"employeeNumber": {
"type": "string"
},
"honorificPrefix": {
"type": "string"
},
"honorificSuffix": {
"type": "string"
},
"preferredLanguage": {
"type": "string"
}
},
"x-okta-tags": [
"User"
],
"x-okta-extensible": true
}
UserSchema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"title": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"$schema": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/UserSchemaProperties"
},
"definitions": {
"$ref": "#/components/schemas/UserSchemaDefinitions"
},
"lastUpdated": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"UserSchema"
]
}
UserSchemaAttribute
{
"type": "object",
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"$ref": "#/components/schemas/UserSchemaAttributeType"
},
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeItems"
},
"oneOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributeEnum"
}
},
"scope": {
"$ref": "#/components/schemas/UserSchemaAttributeScope"
},
"title": {
"type": "string"
},
"union": {
"$ref": "#/components/schemas/UserSchemaAttributeUnion"
},
"master": {
"$ref": "#/components/schemas/UserSchemaAttributeMaster"
},
"unique": {
"type": "string"
},
"pattern": {
"type": "string"
},
"required": {
"type": "boolean"
},
"maxLength": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"mutability": {
"type": "string"
},
"description": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSchemaAttributePermission"
}
},
"externalName": {
"type": "string"
},
"externalNamespace": {
"type": "string"
}
},
"x-okta-tags": [
"UserSchema"
]
}