Skip to main content

Update a User Authentication OpenID Connect Profile Info

PUT Update a User Authentication OpenID Connect Profile Info​

https://useast.api.elasticpath.com/v2/authentication-realms/:realm-id/user-authentication-info/:user-authentication-info-id/user-authentication-oidc-profile-info/:user-authentication-oidc-profile-info-id

Parameters​

Path parameters​

NameRequiredTypeDescription
realm-idRequiredstringThe ID for the authentication-realm containing the requested user-authentication-oidc-profile-info object.
user-authentication-info-idRequiredstringThe ID for the user-authentication-info object containing the requested user-authentication-oidc-profile-info object.
user-authentication-oidc-profile-info-idRequiredstringThe ID for the requested user-authentication-oidc-profile-info object.

Headers​

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Body​

NameRequiredTypeDescription
typeRequiredstringThe type of the object to create. It must be set to user_authentication_oidc_profile_info.
subjectOptionalstringThe identifier within the issuer for the user-authentication-info object. For more information, see the OpenID Connect specification section.
issuerOptionalstringThe identifier for the issuer of the oidc profile. For more information, see the OpenID Connect specification section.
oidc_profile_idOptionalstringThe identifier for the OpenID Connect Profile to which the user-authentication-info object should be linked. Once created, you cannot change oidc_profile_id.

|

Request Examples​

Curl​

curl -X PUT https://useast.api.elasticpath.com/v2/authentication-realms/:id/user-authentication-info/:id2/user-authentication-oidc-profile-info/:user-authentication-oidc-profile-info-id/ \
    -H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $ {
     "data": {
       "type": "user_authentication_info",
        "subject": "testsubject2updated",
        "issuer": "https://sso.provider.com/auth/realms/Sample/",
        "oidc_profile_id": "7f213d23-0a87-41b7-ad24-c58957ac7b9b"
     }
   }

JavaScript SDK​

const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
  client_id: 'X'
})
const realmId = 'XXXX'
const userAuthenticationInfoId = 'XXXX'

Moltin.UserAuthenticationOidcProfileInfo.Update({
      realmId,
      userAuthenticationInfoId,
      body
    }
  )

Response Example​

200 OK

{
  "data": {
    "id": "dc764c11-2a4b-4ab3-be71-45b06d6fec7b",
    "subject": "testsubject2updated",
    "issuer": "https://sso.provider.com/auth/realms/Sample/",
    "meta": {
      "created_at": "2021-06-07T18:25:02.696Z",
      "updated_at": "2021-06-07T18:25:02.696Z"
    },
    "type": "user_authentication_oidc_profile_info",
    "oidc_profile_id": "7f213d23-0a87-41b7-ad24-c58957ac7b9b"
  },
  "links": {
    "self": "https://useast.api.elasticpath.com/v2/authentication-realms/b6cf44b5-5d52-46b8-ae6f-7f28847fb269/user-authentication-info/9738663b-2f64-47e0-b70f-eecd9fb28f53/user-authentication-oidc-profile-info/dc764c11-2a4b-4ab3-be71-45b06d6fec7b"
  }
}