Put V2 Authentication Realms Realm Id

Update an Authentication Realm

PUT/v2/authentication-realms/{realmId}

Use it in a workflow

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

Request

Path parameters

realmIdstring (uuid)required

The ID of the authentication realm to update.

Request body

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

dataobjectrequired

typestringrequired

Specifies the type of object. Set this value to `authentication-realm`.

namestringrequired

Specifies the name of the authentication realm.

duplicate_email_policystring

The values permitted for this parameter are, `allowed` or `api_only`. In Single Sign On (SSO) each user in the Identity Provider (IdP) has a unique identifier, but different IdPs might differ in whether distinct users can share the same email address. For the `allowed` setting, when a user with a new unique identifier signs in through SSO for the first time, the system creates a new user. However, for the `api_only` setting, the system assigns the new unique identifier to the existing user in the system, in this case both the old and new unique identifier from the IdP points to the same user in Commerce. The `api_only` setting is recommended only when all configured identity providers treat e-mail address as a unique identifier for the user, otherwise a user might get access to another user’s account and data. Thus the `api_only` value can simplify administration of users.

One ofalloweddisallowedapi_only

redirect_urisarray<string (uri)>

An array of Storefront URIs that can start Single Sign On authentication. These URIs must follow the rules for [redirection endpoints in OAuth 2.0.](https://tools.ietf.org/html/rfc6749#section-3.1.2) All URIs must start with https:// except for http://localhost.

relationshipsobject1 fields

Specifies the relationships for this authentication realm.

json

{
  "data": {
    "type": "string",
    "name": "my-auth-realm",
    "duplicate_email_policy": "allowed",
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "relationships": {
      "origin": {
        "data": {
          "id": "0",
          "type": "customer-authentication-settings"
        }
      }
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{putV2AuthenticationRealmsRealmId.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?