POST /api/v1/meta/schemas/user/{schemaId}
Updates a User Schema. This updates, adds, or removes one or more profile properties in a User Schema.
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). A property cannot be removed from the default Schema if it is being referenced as a matchAttribute in SAML2 IdPs. Currently, all validation of SAML assertions is only performed against the default user type.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
schemaId |
String | Yes |
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.