POST /api/v1/meta/schemas/user/{schemaId}
Updates a user schema. Use this request to update, add, or remove one or more profile properties in a user schema. If you specify default for the schemaId, updates will apply to the default user type.
Unlike custom user profile properties, limited changes are allowed to base user profile properties (permissions, nullability of the firstName and lastName properties, or pattern for login).
You can't remove a property from the default schema if it's being referenced as a matchAttribute in SAML2 IdPs.
Currently, all validation of SAML assertions are only performed against the default user type.
Note: You must set properties explicitly to
nullto remove them from the schema; otherwise,POSTis interpreted as a partial update.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
schemaId |
String | Yes |
Schema ID. You can also use |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
URI of user schema |
_links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
created |
String | No |
Timestamp when the schema was created |
name |
String | No |
Name of the schema |
title |
String | No |
User-defined display name for the schema |
type |
String | No |
Type of root schema |
$schema |
String | No |
JSON schema version identifier |
lastUpdated |
String | No |
Timestamp when the schema was last updated |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.