Profile

The MyAccount Profile API provides operations to enroll and update profile fields. The API also allows viewing of all allowed profile fields.

API versioning

A valid API version in the Accept header is required to access the API. Current version: 1.0.0

Accept: application/json; okta-version=1.0.0

Retrieve my Profile
OAuth 2.0:
  • okta.myAccount.profile.read

Retrieves the caller's Okta user profile, without attributes excluded by the Get my user profile schema

Responses
200

Example response

401

Unauthorized

406

Not Acceptable (missing header)

get/idp/myaccount/profile
Request samples 
Response samples 
application/json;okta-version=1.0.0
{}
Replace my User Profile
OAuth 2.0: 
  • okta.myAccount.profile.manage
Replaces the caller's user profile




Note: This API differs from the the existing Users API in that only the PUT operation is supported.  Partial updates (PATCH requests) aren't available. All values returned by fetching a user profile must pass to the MyAccount API, or the update doesn't pass validation. This applies even if the omitted schema property is optional. To ensure an optional property passes, enter a value of 'null'.




Request 
Request Body schema: application/json
profile
object
The properties defined in the schema


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


406
Not Acceptable (missing header)


put/idp/myaccount/profile
Request samples 
application/json
{
  • "profile": {
    • "customBoolean": true,
    • "foo": "bar",
    • "login": "example@ex.ample.com",
    • "mobilePhone": "555-555-5555",
    • "customInteger": 42
    }
}
Response samples 
application/json;okta-version=1.0.0
{}
Retrieve my Profile Schema
OAuth 2.0: 
  • okta.myAccount.profile.read
Retrieves the appropriate user profile schema for the caller's user type




Note: If a property's value isn't visible to an end user (because it's hidden or sensitive), then the property's definition is also hidden in the output of the MyAccount API.




Responses 
200
OK


401
Unauthorized


406
Not Acceptable (missing header)


get/idp/myaccount/profile/schema
Request samples 
Response samples 
application/json;okta-version=1.0.0
{
  • "properties": {
    • "customBoolean": {
      },
    • "foo": {
      },
    • "login": {
      },
    • "mobilePhone": {
      },
    • "customInteger": {
      }
    },
  • "_links": {}
}