Post V2 Authentication Realms Realm Id Password Profiles

Create Password Profile

POST/v2/authentication-realms/{realmId}/password-profiles

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Post V2 Authentication Realms Realm Id Password Profiles action (under Single Sign-On).
Fill in the fields below, then reference the result from later steps as {{postV2AuthenticationRealmsRealmIdPasswordProfiles.response.data}}.

Request

Path parameters

realmIdstring (uuid)required

The ID of the authentication realm.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired

typestringrequired

Specifies the type of object. Set this value to `password_profile`.

namestringrequired

Specifies the name of the password profile.

username_formatstring

The format the `username` field must be in when creating or updating a [User Authentication Password Profile Info](/docs/api/single-sign-on/post-v-2-authentication-realms-realm-id-user-authentication-info-user-auth-info-id-user-authentication-password-profile-info). You can change the `username_format` setting, however, the changes apply only to the users created or updated after changing this setting. The new setting does not change the `username_format` for existing users.

One ofemailany

enable_one_time_password_tokenboolean

This enables one time password token requests and events for authentication. This feature is disabled by default.

json

{
  "data": {
    "type": "string",
    "name": "my-password-profile",
    "username_format": "email",
    "enable_one_time_password_token": true
  }
}

Response

Returns 201 with an object. Read it in later steps with {{postV2AuthenticationRealmsRealmIdPasswordProfiles.response.data.<field>}}.

dataany

linksobject

selfstring (uri)

A URL to the specific resource.

json

{
  "data": null,
  "links": {
    "self": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?