User Types

The User Types API provides operations to manage User Types.

List all User Types
OAuth 2.0: okta.userTypes.read

Lists all User Types in your org

Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/meta/types/user
Request samples
Response samples
application/json
[]

Create a User Type
OAuth 2.0: okta.userTypes.manage

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.

Request
Request Body schema: application/json
required
description
string

The human-readable description of the User Type

displayName
required
string

The human-readable name of the User Type

name
required
string

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.

Responses
200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/meta/types/user
Request samples
application/json
{
  • "description": "A new custom user type",
  • "displayName": "New User Type",
  • "name": "newUserType"
}
Response samples
application/json
{}

Retrieve a User Type
OAuth 2.0: okta.userTypes.read

Retrieves a User Type by ID. Use default to fetch the default User Type.

Request
path Parameters
typeId
required
string

The unique key for the User Type

Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/meta/types/user/{typeId}
Request samples
Response samples
application/json
{}

Update a User Type
OAuth 2.0: okta.userTypes.manage

Updates an existing User Type. This operation is a partial update.

Note: You can only update the displayName and description elements. The name of an existing User Type can't be changed.

Request
path Parameters
typeId
required
string

The unique key for the User Type

Request Body schema: application/json
required
description
string

The updated human-readable description of the User Type

displayName
string

The updated human-readable display name for the User Type

Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/meta/types/user/{typeId}
Request samples
application/json
{
  • "displayName": "Updated Display Name"
}
Response samples
application/json
{}

Replace a User Type
OAuth 2.0: okta.userTypes.manage

Replaces an existing User Type. This operation is a full update.

Note: The name of an existing User Type can't be changed, but must be part of the request body. You can only replace the displayName and description elements.

Request
path Parameters
typeId
required
string

The unique key for the User Type

Request Body schema: application/json
description
required
string

The human-readable description of the User Type

displayName
required
string

The human-readable name of the User Type

name
required
string

The name of the existing type

Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

put/api/v1/meta/types/user/{typeId}
Request samples
application/json
{
  • "displayName": "Replacement Display Name",
  • "description": "Replacement description",
  • "name": "newUserType"
}
Response samples
application/json
{}

Delete a User Type
OAuth 2.0: okta.userTypes.manage

Deletes a User Type permanently.

Note: You can't delete the default User Type or a User Type that is currently assigned to users.

Request
path Parameters
typeId
required
string

The unique key for the User Type

Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

delete/api/v1/meta/types/user/{typeId}
Request samples
Response samples
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}