POST /api/v1/meta/schemas/apps/{appId}/default
Updates the app user schema. This updates, adds, or removes one or more custom profile properties or the nullability of a base property in the app user schema for an app. Changing a base property's nullability (for example, the value of its required field) is allowed only if it is nullable in the default predefined schema for the app.
Note: You must set properties explicitly to
nullto remove them from the schema; otherwise,POSTis interpreted as a partial update.
The User Types feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify default and don't accept a schema ID.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appId |
String | Yes |
Application ID |
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.