examples
ErrorAccessDenied
{
"summary": "Access Denied",
"value": {
"errorCode": "E0000006",
"errorSummary": "You do not have permission to perform the requested action",
"errorLink": "E0000006",
"errorId": "sampleNUSD_8fdkFd8fs8SDBK",
"errorCauses": []
}
}
ErrorResourceNotFound
{
"summary": "Resource Not Found",
"value": {
"errorCode": "E0000007",
"errorSummary": "Not found: {0}",
"errorLink": "E0000007",
"errorId": "sampleMlLvGUj_YD5v16vkYWY",
"errorCauses": []
}
}
ErrorTooManyRequests
{
"summary": "Too Many Requests",
"value": {
"errorCode": "E0000047",
"errorSummary": "API call exceeded rate limit due to too many requests.",
"errorLink": "E0000047",
"errorId": "sampleQPivGUj_ND5v78vbYWW",
"errorCauses": []
}
}
ExpirePwdResponse
{
"value": {
"id": "00ub0oNGTSWTBKOLGLNR",
"status": "PASSWORD_EXPIRED",
"created": "2013-06-24T16:39:18.000Z",
"activated": "2013-06-24T16:39:19.000Z",
"statusChanged": "2013-06-24T16:39:19.000Z",
"lastLogin": "2013-06-24T17:39:19.000Z",
"lastUpdated": "2013-06-27T16:35:28.000Z",
"passwordChanged": "2013-06-24T16:39:19.000Z",
"profile": {
"firstName": "Isaac",
"lastName": "Brock",
"email": "isaac.brock@example.com",
"login": "isaac.brock@example.com",
"mobilePhone": "555-415-1337"
},
"credentials": {
"password": {},
"recovery_question": {
"question": "Who's a major player in the cowboy scene?"
},
"provider": {
"type": "OKTA",
"name": "OKTA"
}
},
"_links": {
"resetPassword": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_password"
},
"resetFactors": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_factors"
},
"expirePassword": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/expire_password"
},
"forgotPassword": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/forgot_password"
},
"changeRecoveryQuestion": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_recovery_question"
},
"deactivate": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/deactivate"
},
"changePassword": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_password"
}
}
}
}
ForgotPwdResponse
{
"value": {
"resetPasswordUrl": "https://{yourOktaDomain}/signin/reset-password/XE6wE17zmphl3KqAPFxO"
}
}
ListUserGroups
{
"value": [
{
"id": "0gabcd1234",
"profile": {
"name": "Cloud app users",
"description": "Users can access cloud apps"
}
},
{
"id": "0gefgh5678",
"profile": {
"name": "Internal app users",
"description": "Users can access internal apps"
}
}
]
}
ListUsersResponse
{
"summary": "List all users",
"value": [
{
"id": "00u118oQYT4TBTemp0g4",
"status": "ACTIVE",
"created": "2022-04-04T15:56:05.000Z",
"activated": null,
"statusChanged": null,
"lastLogin": "2022-05-04T19:50:52.000Z",
"lastUpdated": "2022-05-05T18:15:44.000Z",
"passwordChanged": "2022-04-04T16:00:22.000Z",
"type": {
"id": "oty1162QAr8hJjTaq0g4"
},
"profile": {
"firstName": "Alice",
"lastName": "Smith",
"mobilePhone": null,
"secondEmail": null,
"login": "alice.smith@example.com",
"email": "alice.smith@example.com"
},
"credentials": {
"password": {},
"provider": {
"type": "OKTA",
"name": "OKTA"
}
},
"_links": {
"self": {
"href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4"
}
}
}
]
}
user-example
{
"summary": "User example",
"value": {
"id": "00ub0oNGTSWTBKOLGLNR",
"status": "ACTIVE",
"created": "2013-06-24T16:39:18.000Z",
"activated": "2013-06-24T16:39:19.000Z",
"statusChanged": "2013-06-24T16:39:19.000Z",
"lastLogin": "2013-06-24T17:39:19.000Z",
"lastUpdated": "2013-07-02T21:36:25.344Z",
"passwordChanged": "2013-07-02T21:36:25.344Z",
"profile": {
"login": "isaac.brock@example.com",
"firstName": "Isaac",
"lastName": "Brock",
"nickName": "issac",
"displayName": "Isaac Brock",
"email": "isaac.brock@example.com",
"secondEmail": "isaac@example.org",
"profileUrl": "http://www.example.com/profile",
"preferredLanguage": "en-US",
"userType": "Employee",
"organization": "Okta",
"title": "Director",
"division": "R&D",
"department": "Engineering",
"costCenter": "10",
"employeeNumber": "187",
"mobilePhone": "+1-555-415-1337",
"primaryPhone": "+1-555-514-1337",
"streetAddress": "301 Brannan St.",
"city": "San Francisco",
"state": "CA",
"zipCode": "94107",
"countryCode": "US"
},
"credentials": {
"password": {},
"recovery_question": {
"question": "What's my childhood elementary school?"
},
"provider": {
"type": "OKTA",
"name": "OKTA"
}
},
"_links": {
"self": {
"href": "https://{yourOktaDomain}/api/v1/users/00u1f96ECLNVOKVMUSEA"
}
}
}
}
schemas
AuthenticationProvider
{
"description": "Specifies the authentication provider that validates the user's password credential. The user's current provider is managed by the **Delegated Authentication** settings for your org. The provider object is **read-only**.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the authentication provider",
"readOnly": true,
"example": "OKTA"
},
"type": {
"$ref": "#/components/schemas/AuthenticationProviderType"
}
},
"readOnly": true
}
AuthenticationProviderType
{
"description": "The type of authentication provider",
"type": "string",
"enum": [
"ACTIVE_DIRECTORY",
"FEDERATION",
"IMPORT",
"LDAP",
"OKTA",
"SOCIAL"
],
"x-enumDescriptions": {
"ACTIVE_DIRECTORY": "Specifies the Microsoft Active Directory instance name as the `name` property",
"FEDERATION": "Specifies a federated identity provider (such as an SAML IdP) that validates the user's password credentials. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider.",
"IMPORT": "Specifies a hashed password that was imported from an external source",
"LDAP": "Specifies the LDAP directory instance name as the `name` property",
"OKTA": "Specifies the Okta identity provider",
"SOCIAL": "Specifies an OIDC or third-party social identity provider. Doesn't support a `password` or `recovery question` credential. The user must authenticate through a trusted identity provider."
},
"readOnly": true
}
DigestAlgorithm
{
"description": "Algorithm used to generate the key. Only required for the PBKDF2 algorithm.",
"type": "string",
"enum": [
"SHA256_HMAC",
"SHA512_HMAC"
]
}
Error
{
"title": "Error",
"type": "object",
"properties": {
"errorCauses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorCause"
}
},
"errorCode": {
"type": "string",
"description": "An Okta code for this type of error"
},
"errorId": {
"type": "string",
"description": "A unique identifier for this error. This can be used by Okta Support to help with troubleshooting."
},
"errorLink": {
"type": "string",
"description": "An Okta code for this type of error"
},
"errorSummary": {
"type": "string",
"description": "A short description of what caused this error. Sometimes this contains dynamically-generated information about your specific error."
}
}
}
ErrorCause
{
"type": "object",
"properties": {
"errorSummary": {
"type": "string"
}
}
}
ForgotPasswordResponse
{
"type": "object",
"properties": {
"resetPasswordUrl": {
"type": "string",
"readOnly": true
}
}
}
Group
{
"x-okta-ignore-redocly-rules-for-sdk": true,
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Timestamp when the group was created"
},
"id": {
"type": "string",
"readOnly": true,
"example": "0gabcd1234",
"description": "Unique ID for the group"
},
"lastMembershipUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Timestamp when the groups memberships were last updated"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Timestamp when the group's profile was last updated"
},
"objectClass": {
"type": "array",
"readOnly": true,
"description": "Determines the group's `profile`",
"items": {
"type": "string"
}
},
"profile": {
"$ref": "#/components/schemas/GroupProfile"
},
"type": {
"$ref": "#/components/schemas/GroupType"
},
"_embedded": {
"type": "object",
"description": "Embedded resources related to the group",
"readOnly": true,
"properties": {
"stats": {
"description": "Statistics about the group",
"type": "object",
"properties": {
"usersCount": {
"type": "integer",
"format": "int32",
"description": "Number of users in the group"
},
"appsCount": {
"type": "integer",
"format": "int32",
"description": "Number of apps associated with the group"
},
"groupPushMappingsCount": {
"type": "integer",
"format": "int32",
"description": "Number of group push mappings associated with the group"
},
"hasAdminPrivlege": {
"type": "boolean",
"description": "Indicates if the group has admin privileges via a group-level role assignment"
}
}
},
"app": {
"description": "If the group is sourced from an app, this object contains information about that app",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the `AppInstance`"
},
"name": {
"type": "string",
"description": "The name of the `AppInstance`"
},
"label": {
"type": "string",
"description": "The user-facing display name of the `AppInstance`"
},
"signOnMode": {
"type": "string",
"description": "The configured sign-on mode for the `AppInstance`",
"example": "SAML_1_1"
}
}
}
}
},
"_links": {
"description": "[Discoverable resources](/openapi/okta-management/management/group/listgroups#group/listgroups/t=response&c=200&path=_links/source) related to the group",
"allOf": [
{
"$ref": "#/components/schemas/LinksSelf"
},
{
"properties": {
"apps": {
"$ref": "#/components/schemas/HrefObject"
},
"logo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HrefObject"
}
},
"source": {
"$ref": "#/components/schemas/HrefObject"
},
"users": {
"$ref": "#/components/schemas/HrefObject"
}
}
}
]
}
}
}
GroupProfile
{
"anyOf": [
{
"$ref": "#/components/schemas/OktaUserGroupProfile"
},
{
"$ref": "#/components/schemas/OktaActiveDirectoryGroupProfile"
}
]
}
GroupType
{
"description": "Determines how a group's profile and memberships are managed",
"type": "string",
"enum": [
"APP_GROUP",
"BUILT_IN",
"OKTA_GROUP"
],
"x-enumDescriptions": {
"APP_GROUP": "Group profile and memberships are imported and must be managed within the app (such as Active Directory or LDAP) that imported the group",
"BUILT_IN": "Group profile and memberships are managed by Okta and can't be modified",
"OKTA_GROUP": "Group profile and memberships are directly managed in Okta via static assignments or indirectly through group rules"
}
}
HrefHints
{
"description": "Describes allowed HTTP verbs for the `href`",
"type": "object",
"properties": {
"allow": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HttpMethod"
}
}
}
}
HrefObject
{
"x-okta-ignore-redocly-rules-for-sdk": true,
"title": "Link Object",
"additionalProperties": true,
"type": "object",
"properties": {
"hints": {
"$ref": "#/components/schemas/HrefHints",
"readOnly": true
},
"href": {
"type": "string",
"description": "Link URI"
},
"name": {
"type": "string",
"description": "Link name",
"readOnly": true
},
"templated": {
"type": "boolean",
"description": "Indicates whether the link object's `href` property is a URI template.",
"readOnly": true
},
"type": {
"type": "string",
"description": "The media type of the link. If omitted, it is implicitly `application/json`.",
"readOnly": true
}
},
"required": [
"href"
]
}
HrefObjectSelfLink
{
"x-okta-ignore-redocly-rules-for-sdk": true,
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
},
{
"description": "Link to the resource (self)"
}
]
}
HttpMethod
{
"type": "string",
"enum": [
"DELETE",
"GET",
"POST",
"PUT"
]
}
LinksSelf
{
"description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.",
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HrefObjectSelfLink"
}
},
"readOnly": true
}
OktaActiveDirectoryGroupProfile
{
"description": "Profile for a group that is imported from Active Directory.\n\nThe `objectClass` for such groups is `okta:windows_security_principal`.\n\nYou can extend group profiles with custom properties, but you must first add the properties to the group profile schema before you can reference them. Use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) to manage schema extensions.\n\nCustom properties can contain HTML tags. It is the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.",
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "All users in the engineering department",
"description": "Description of the Windows group"
},
"dn": {
"type": "string",
"example": "CN=West Coast users,OU=West Coast,DC=example,DC=com",
"description": "The distinguished name of the Windows group"
},
"externalId": {
"type": "string",
"example": "VKzYZ1C+IkSZxIWlrW5ITg==",
"description": "Base-64 encoded GUID (`objectGUID`) of the Windows group"
},
"name": {
"type": "string",
"example": "West Coast users",
"description": "Name of the Windows group"
},
"samAccountName": {
"type": "string",
"example": "West Coast users",
"description": "Pre-Windows 2000 name of the Windows group"
},
"windowsDomainQualifiedName": {
"type": "string",
"example": "EXAMPLE\\\\West Coast users",
"description": "Fully qualified name of the Windows group"
}
}
}
OktaUserGroupProfile
{
"description": "Profile for any group that is not imported from Active Directory. Specifies the standard\nand custom profile properties for a group.\n\nThe `objectClass` for these groups is `okta:user_group`.\n\nYou can extend group profiles with custom properties, but you must first add the properties to the group profile schema before you can reference them. Use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/) to manage schema extensions.\n\nCustom properties can contain HTML tags. It is the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.",
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "All users West of The Rockies",
"description": "Description of the group"
},
"name": {
"type": "string",
"example": "West Coast users",
"description": "Name of the group"
}
},
"x-okta-extensible": true
}
PasswordCredential
{
"description": "Specifies a password for a user.\n\nWhen a user has a valid password, imported hashed password, or password hook, and a response object contains\na password credential, then the password object is a bare object without the value property defined (for example, `password: {}`). This indicates that a password value exists. You can modify password policy requirements in the Admin Console by editing the Password authenticator: **Security** > **Authenticators** > **Password** (or for Okta Classic orgs, use **Security** > **Authentication** > **Password**).\n\nFor information on defaults and configuring your password policies, see [Configure the password authenticator](https://help.okta.com/okta_help.htm?type=oie&id=ext-configure-password) in the help documentation.",
"type": "object",
"properties": {
"hash": {
"$ref": "#/components/schemas/PasswordCredentialHash"
},
"hook": {
"$ref": "#/components/schemas/PasswordCredentialHook"
},
"value": {
"type": "string",
"writeOnly": true,
"description": "Specifies the password for a user. The password policy validates this password.",
"format": "password",
"example": "pa$$word"
}
}
}
PasswordCredentialHash
{
"description": "Specifies a hashed password to import into Okta. This allows an existing password to be imported into Okta directly\nfrom some other store. Okta supports the BCRYPT, SHA-512, SHA-256, SHA-1, MD5, and PBKDF2 hash functions for password import.\n A hashed password may be specified in a password object when creating or updating a user, but not for other operations.\n See the [Create user with imported hashed password](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#create-user-with-imported-hashed-password) description. When you update a user with a hashed password, the user must be in the `STAGED` status.",
"type": "object",
"properties": {
"algorithm": {
"$ref": "#/components/schemas/PasswordCredentialHashAlgorithm"
},
"digestAlgorithm": {
"$ref": "#/components/schemas/DigestAlgorithm"
},
"iterationCount": {
"type": "integer",
"description": "The number of iterations used when hashing passwords using PBKDF2. Must be >= 4096. Only required for PBKDF2 algorithm."
},
"keySize": {
"type": "integer",
"description": "Size of the derived key in bytes. Only required for PBKDF2 algorithm."
},
"salt": {
"description": "Only required for salted hashes. For BCRYPT, this specifies Radix-64 as the encoded salt used to generate the hash,\nwhich must be 22 characters long. For other salted hashes, this specifies the Base64-encoded salt used to\ngenerate the hash.",
"type": "string"
},
"saltOrder": {
"type": "string",
"description": "Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms."
},
"value": {
"description": "For SHA-512, SHA-256, SHA-1, MD5, and PBKDF2, this is the actual base64-encoded hash of the password (and salt, if used).\nThis is the Base64-encoded `value` of the SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest that was computed by either pre-fixing or post-fixing\nthe `salt` to the `password`, depending on the `saltOrder`. If a `salt` was not used in the `source` system, then this should just be\nthe Base64-encoded `value` of the password's SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest. For BCRYPT, this is the actual Radix-64 encoded hashed password.",
"type": "string"
},
"workFactor": {
"type": "integer",
"description": "Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm.",
"minimum": 1,
"maximum": 20
}
}
}
PasswordCredentialHashAlgorithm
{
"description": "The algorithm used to generate the hash using the password (and salt, when applicable).",
"type": "string",
"enum": [
"BCRYPT",
"MD5",
"PBKDF2",
"SHA-1",
"SHA-256",
"SHA-512"
]
}
PasswordCredentialHook
{
"description": "Specify a [password import inline hook](/openapi/okta-management/management/tags/inlinehook/createpasswordimportinlinehook) to trigger verification of the user's password the first time the user signs in. This allows an existing password to be imported into Okta directly from some other store.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of password inline hook. Currently, must be set to default."
}
}
}
RecoveryQuestionCredential
{
"description": "Specifies a secret question and answer that's validated (case insensitive) when a user forgets their\npassword or unlocks their account. The answer property is write-only.",
"type": "object",
"properties": {
"answer": {
"type": "string",
"description": "The answer to the recovery question",
"minimum": 1,
"maximum": 100,
"writeOnly": true,
"example": "se7en"
},
"question": {
"type": "string",
"description": "The recovery question",
"minimum": 1,
"maximum": 100,
"example": "what is your favourite movie?"
}
}
}
User
{
"x-okta-ignore-redocly-rules-for-sdk": true,
"type": "object",
"properties": {
"activated": {
"type": "string",
"description": "The timestamp when the user status transitioned to `ACTIVE`",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"created": {
"type": "string",
"description": "The timestamp when the user was created",
"format": "date-time",
"readOnly": true
},
"credentials": {
"$ref": "#/components/schemas/UserCredentials"
},
"id": {
"type": "string",
"description": "The unique key for the user",
"readOnly": true
},
"lastLogin": {
"type": "string",
"description": "The timestamp of the last login",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"lastUpdated": {
"type": "string",
"description": "The timestamp when the user was last updated",
"format": "date-time",
"readOnly": true
},
"passwordChanged": {
"type": "string",
"description": "The timestamp when the user's password was last updated",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"profile": {
"$ref": "#/components/schemas/UserProfile"
},
"realmId": {
"type": "string",
"description": "The ID of the realm in which the user is residing. See [Realms](/openapi/okta-management/management/tags/realm).",
"example": "guo1bfiNtSnZYILxO0g4",
"readOnly": true
},
"status": {
"$ref": "#/components/schemas/UserStatus"
},
"statusChanged": {
"type": "string",
"description": "The timestamp when the status of the user last changed",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"transitioningToStatus": {
"type": "string",
"description": "The target status of an in-progress asynchronous status transition. This property is only returned if the user's state is transitioning.",
"readOnly": true,
"nullable": true,
"enum": [
"ACTIVE",
"DEPROVISIONED",
"PROVISIONED"
]
},
"type": {
"type": "object",
"description": "The user type that determines the schema for the user's profile. The `type` property is a map that identifies the [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/#tag/UserType).\n\nCurrently it contains a single element, `id`. It can be specified when creating a new user, and can be updated by an admin on a full replace of an existing user (but not a partial update).",
"properties": {
"id": {
"type": "string",
"description": "The ID of the user type"
}
}
},
"_embedded": {
"type": "object",
"description": "Embedded resources related to the user using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification",
"additionalProperties": {
"type": "object",
"properties": {}
},
"readOnly": true
},
"_links": {
"description": "Specifies link relations (see [Web Linking](https://datatracker.ietf.org/doc/html/rfc8288) available for the current status of a user.\nThe links object is used for dynamic discovery of related resources, lifecycle operations, and credential operations. The links object is read-only.\n\nFor an individual user result, the links object contains a full set of link relations available for that user as determined by your policies.\nFor a collection of users, the links object contains only the `self` link. Operations that return a collection of users include [List all users](https://developer.okta.com/docs/api/openapi/okta-management/management/user/listusers) and [List all group member users](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroupUsers).",
"allOf": [
{
"$ref": "#/components/schemas/LinksSelf"
},
{
"type": "object",
"properties": {
"self": {
"description": "URL to the individual user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"activate": {
"description": "URL to activate the user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"resetPassword": {
"description": "URL to reset the user's password",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"resetFactors": {
"description": "URL to reset the user's factors",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"expirePassword": {
"description": "URL to expire the user's password",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"forgotPassword": {
"description": "URL to initiate a forgot password operation",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"changeRecoveryQuestion": {
"description": "URL to change the user's recovery question",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"deactivate": {
"description": "URL to deactivate a user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"reactivate": {
"description": "URL to reactivate the user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"changePassword": {
"description": "URL to change the user's password",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"schema": {
"description": "URL to the user's profile schema",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"suspend": {
"description": "URL to suspend the user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"unsuspend": {
"description": "URL to unsuspend the user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"unlock": {
"description": "URL to unlock the locked-out user",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
},
"type": {
"description": "URL to the user type",
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
]
}
}
},
{
"readOnly": true
}
]
}
}
}
UserBlock
{
"description": "Describes how the account is blocked from access. If `appliesTo` is `ANY_DEVICES`, then the account is blocked for all devices. If `appliesTo` is `UNKNOWN_DEVICES`, then the account is only blocked for unknown devices.",
"type": "object",
"properties": {
"appliesTo": {
"type": "string",
"readOnly": true,
"description": "The devices that the block applies to",
"enum": [
"ANY_DEVICES",
"UNKNOWN_DEVICES"
],
"x-enumDescriptions": {
"ANY_DEVICES": "The account is blocked for all devices",
"UNKNOWN_DEVICES": "The account is only blocked for unknown devices"
}
},
"type": {
"type": "string",
"readOnly": true,
"description": "Type of access block",
"enum": [
"DEVICE_BASED"
]
}
}
}
UserCredentials
{
"description": "Specifies primary authentication and recovery credentials for a user. Credential types and requirements vary depending on the provider and security policy of the org.",
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/PasswordCredential"
},
"provider": {
"$ref": "#/components/schemas/AuthenticationProvider"
},
"recovery_question": {
"$ref": "#/components/schemas/RecoveryQuestionCredential"
}
}
}
UserGetSingleton
{
"allOf": [
{
"$ref": "#/components/schemas/User"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "object",
"description": "The embedded resources related to the object if the `expand` query parameter is specified",
"properties": {
"blocks": {
"type": "array",
"description": "A list of access block details for the user account",
"items": {
"$ref": "#/components/schemas/UserBlock"
}
}
}
}
}
}
]
}
UserProfile
{
"additionalProperties": true,
"description": "Specifies the default and custom profile properties for a user.\n\nThe default user profile is based on the [System for Cross-domain Identity Management: Core Schema](https://datatracker.ietf.org/doc/html/rfc7643).\n\nThe only permitted customizations of the default profile are to update permissions, change whether the `firstName` and `lastName` properties are nullable, and specify a [pattern](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation) for `login`. You can use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to make schema modifications.\n\nYou can extend user profiles with custom properties. You must first add the custom property to the user profile schema before you reference it.\nYou can use the Profile Editor in the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to manage schema extensions.\n\nCustom attributes can contain HTML tags. It's the client's responsibility to escape or encode this data before displaying it. Use [best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to prevent cross-site scripting.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city or locality of the user's address (`locality`)",
"maxLength": 128,
"nullable": true
},
"costCenter": {
"type": "string",
"description": "Name of the cost center assigned to a user",
"nullable": true
},
"countryCode": {
"description": "The country name component of the user's address (`country`). For validation, see [ISO 3166-1 alpha 2 \"short\" code format](https://datatracker.ietf.org/doc/html/draft-ietf-scim-core-schema-22#ref-ISO3166).",
"type": "string",
"maxLength": 2,
"nullable": true
},
"department": {
"type": "string",
"description": "Name of the user's department"
},
"displayName": {
"type": "string",
"description": "Name of the user suitable for display to end users",
"nullable": true
},
"division": {
"type": "string",
"description": "Name of the user's division",
"nullable": true
},
"email": {
"type": "string",
"description": "The primary email address of the user. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).",
"format": "email",
"minLength": 5,
"maxLength": 100
},
"employeeNumber": {
"description": "The organization or company assigned unique identifier for the user",
"type": "string"
},
"firstName": {
"type": "string",
"description": "Given name of the user (`givenName`)",
"minLength": 1,
"maxLength": 50,
"nullable": true
},
"honorificPrefix": {
"type": "string",
"description": "Honorific prefix(es) of the user, or title in most Western languages",
"nullable": true
},
"honorificSuffix": {
"type": "string",
"description": "Honorific suffix(es) of the user",
"nullable": true
},
"lastName": {
"type": "string",
"description": "The family name of the user (`familyName`)",
"minLength": 1,
"maxLength": 50,
"nullable": true
},
"locale": {
"type": "string",
"description": "The user's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.\nA locale value is a concatenation of the ISO 639-1 two-letter language code, an underscore, and the ISO 3166-1 two-letter country code. For example, en_US specifies the language English and country US. This value is `en_US` by default."
},
"login": {
"type": "string",
"description": "The unique identifier for the user (`username`). For validation, see [Login pattern validation](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation).\n\nEvery user within your Okta org must have a unique identifier for a login. This constraint applies to all users you import from other systems or applications such as Active Directory. Your organization is the top-level namespace to mix and match logins from all your connected applications or directories. Careful consideration of naming conventions for your login identifier will make it easier to onboard new applications in the future.\n\nLogins are not considered unique if they differ only in case and/or diacritical marks. If one of your users has a login of `Isaac.Brock@example.com`, there cannot be another user whose login is `isaac.brock@example.com`, nor `isáàc.bröck@example.com`.\n\nOkta has a default ambiguous name resolution policy for usernames that include @-signs. By default, usernames must be formatted as email addresses and thus always include @-signs. You can remove that restriction using either the Admin Console or the [Schemas API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/). Users can sign in with their non-qualified short name (for example: `isaac.brock` with username `isaac.brock@example.com`) as long as the short name is still unique within the org.",
"maxLength": 100,
"minLength": 5
},
"manager": {
"type": "string",
"description": "The `displayName` of the user's manager",
"nullable": true
},
"managerId": {
"type": "string",
"description": "The `id` of the user's manager",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The middle name of the user",
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "The mobile phone number of the user",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"nickName": {
"type": "string",
"description": "The casual way to address the user in real life",
"nullable": true
},
"organization": {
"type": "string",
"description": "Name of the the user's organization",
"nullable": true
},
"postalAddress": {
"type": "string",
"description": "Mailing address component of the user's address",
"maxLength": 4096,
"nullable": true
},
"preferredLanguage": {
"type": "string",
"description": "The user's preferred written or spoken language. For validation, see [RFC 7231 Section 5.3.5](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5).",
"nullable": true
},
"primaryPhone": {
"type": "string",
"description": "The primary phone number of the user such as a home number",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"profileUrl": {
"type": "string",
"description": "The URL of the user's online profile. For example, a web page. See [URL](https://datatracker.ietf.org/doc/html/rfc1808).",
"nullable": true
},
"secondEmail": {
"type": "string",
"format": "email",
"description": "The secondary email address of the user typically used for account recovery. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).",
"maxLength": 100,
"nullable": true
},
"state": {
"type": "string",
"description": "The state or region component of the user's address (`region`)",
"maxLength": 128,
"nullable": true
},
"streetAddress": {
"type": "string",
"description": "The full street address component of the user's address",
"maxLength": 1024,
"nullable": true
},
"timezone": {
"type": "string",
"description": "The user's time zone",
"nullable": true
},
"title": {
"type": "string",
"description": "The user's title, such as Vice President",
"nullable": true
},
"userType": {
"type": "string",
"description": "The property used to describe the organization-to-user relationship, such as employee or contractor\n\n> **Note:** The `userType` property is a standard string attribute and should be treated as a descriptive label rather than a functional setting. Unlike a user's assigned user [`type`](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=type&t=request), this property is purely informational and doesn't influence the behavior of the Okta platform.",
"nullable": true
},
"zipCode": {
"type": "string",
"description": "The ZIP code or postal code component of the user's address (`postalCode`)",
"maxLength": 50,
"nullable": true
}
}
}
UserStatus
{
"description": "The current status of the user.\n\nThe status of a user changes in response to explicit events, such as admin-driven lifecycle changes, user login, or self-service password recovery. Okta doesn't asynchronously sweep through users and update their password expiry state, for example. Instead, Okta evaluates password policy at login time, notices the password has expired, and moves the user to the expired state. When running reports, remember that the data is valid as of the last login or lifecycle event for that user.\n\n> **Note:** The `ACTIVATING` status is a transitional status that occurs when a user is being activated but hasn't completed the activation process. This status isn't directly settable through the API, nor should you use it for any of your user management workflows.",
"type": "string",
"enum": [
"ACTIVE",
"DEPROVISIONED",
"LOCKED_OUT",
"PASSWORD_EXPIRED",
"PROVISIONED",
"RECOVERY",
"STAGED",
"SUSPENDED"
],
"readOnly": true
}