Skip to main content

Update a User Authentication Password Profile

PUT Update a User Authentication Password Profile Info

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

Parameters

Path parameters

NameRequiredTypeDescription
realm-idRequiredstringThe ID for the authentication-realm containing the requested user-authentication-password-profile-info object.
user-authentication-info-idRequiredstringThe ID for the user-authentication-info linked to the requested user-authentication-info-password-profile-info object.
user-authentication-password-profile-info-idRequiredstringThe ID for the user-authentication-info-password-profile-info object.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.
EP-Account-Management-Authentication-TokenOptionalstringAn account management authentication token that identifies the authenticated account member. This is required when the bearer token is an implicit token.

Body

NameRequiredTypeDescription
typeRequiredstringThe type of the object. Set this value to user-authentication-password-profile-info object.
idRequiredstringThe ID of the 'user-authentication-password-profile-info' object.
usernameOptionalstringThe username used to authenticate.
passwordOptionalstringThe password used to authenticate. The password must be at least 8 characters.

Request Examples

Curl

curl -X PUT https://useast.api.elasticpath.com/v2/authentication-realms/:realm-id/user-authentication-info/:user-authentication-info-id/user-authentication-password-profile-info/:user-authentication-password-profile-info \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $'{
"data": {
"type": "user_authentication_password_profile_info",
"id": "486fa6f1-d85a-44a0-abdf-ff0076fffd6c",
"username": "john.doe",
"password" : "password"
}
}'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
client_id: 'X'
})
const realmId = 'XXXX'
const userAuthenticationInfoId = 'XXXX'
const userAuthenticationPasswordProfileId = 'XXXX'
Moltin.UserAuthenticationPasswordProfile.Update({
realmId,
userAuthenticationId,
userAuthenticationPasswordProfileId,
body
}
)

Response Example

200 OK

{
"data": {
"id": "2b2dd626-9960-40c6-a9f9-d4af96eed3fb",
"username": "john.doe",
"meta": {
"created_at": "2021-06-07T15:58:08.198Z",
"updated_at": "2021-06-07T15:58:08.198Z"
},
"type": "user_authentication_password_profile_info",
"password_profile_id": "a760a1f3-5680-420e-bcc4-a924de8b1a11"
},
"links": {
"self": "https://useast.api.elasticpath.com/authentication-realms/12b33a5d-b536-47a8-987d-9cdba15f1647/user-authentication-info/a9dc5358-c3ee-44f9-a36c-3057213e750d/user-authentication-password-profile-info/2b2dd626-9960-40c6-a9f9-d4af96eed3fb"
}
}