PATCH /api/v1/identity-sources/{identitySourceId}/users/{externalId}

Updates a user to an identity source for the given identity source instance and external ID

Servers

Path parameters

Name Type Required Description
externalId String Yes

The external ID of the user

identitySourceId String Yes

The ID of the identity source for which the session is created

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

Contains a set of external user attributes and their values that are mapped to Okta standard and custom profile properties. See the profile object and Declaration of a Custom Identity Source Schema in Using anything as a source.

Note: Profile attributes can only be of the string type.

profile.homeAddress String No

Home address of the user

profile.userName String No

Username of the user

profile.email String No

Email address of the user

profile.lastName String No

Last name of the user

profile.mobilePhone String No

Mobile phone number of the user

profile.firstName String No

First name of the user

profile.secondEmail String No

Alternative email address of the user

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.