PUT /api/v1/realms/{realmId}

Replaces the realm profile

Servers

Path parameters

Name Type Required Description
realmId String Yes

ID of the realm

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
profile Object No
profile.domains[] Array No

Array of allowed domains. No user in this realm can be created or updated unless they have a username and email from one of these domains.

The following characters aren't allowed in the domain name: !$%^&()=*+,:;<>'[]|/?\

profile.name String Yes

Name of a realm

profile.realmType String No

Used to store partner users. This property must be set to PARTNER to access Okta's external partner portal.

Valid values:

  • "DEFAULT"
  • "PARTNER"

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.