POST /api/v1/meta/types/user

Creates a new user type. Okta automatically creates a default user type for your org. You may add up to nine additional user types.

Note: New user types are based on the current default schema template. Modifications to this schema do not automatically propagate to previously created user types.

Servers

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

The unique key for the user type

created String No

A timestamp from when the user type was created

name String Yes

The name of the user type. The name must start with A-Z or a-z and contain only A-Z, a-z, 0-9, or underscore (_) characters. This value becomes read-only after creation and can't be updated.

description String No

The human-readable description of the user type

default Boolean No

A boolean value to indicate if this is the default user type

displayName String Yes

The human-readable name of the user type

lastUpdatedBy String No

The user ID of the most recent account to edit the user type

createdBy String No

The user ID of the account that created the user type

lastUpdated String No

A timestamp from when the user type was most recently updated

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.