Skip to main content

Update a User Authentication Info

PUT Update a User Authentication Info

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

Parameters

Path parameters

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

Headers

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

Body

NameRequiredTypeDescription
nameRequiredstringThe name used for the user_authentication_info object.
emailRequiredstringThe email address used for the user_authentication_info object.
typeRequiredstringThe type of the object to create. Always user_authentication_info

Request Examples

Curl

curl -X PUT https://useast.api.elasticpath.com/v2/authentication-realms/:id/user-authentication-info/:id2 \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $'{
"data": {
"type": "user_authentication_info",
"name": "John Doe Updated",
"email": "john.doe@banks.com"
}
}'

JavaScript SDK

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

Response Example

200 OK

{
"data": {
"id": "787af9a4-83e1-4216-bc60-df076daef0c5",
"name": "John Doe Updated",
"email": "john.doe@banks.com",
"meta": {
"created_at": "2021-06-02T18:44:07.617Z",
"updated_at": "2021-06-02T18:44:07.617Z",
"creation_status": "COMPLETE"
},
"type": "user_authentication_info"
},
"links": {
"self": "https://useast.api.elasticpath.com/v2/authentication-realms/b6cf44b5-5d52-46b8-ae6f-7f28847fb269/user-authentication-info/787af9a4-83e1-4216-bc60-df076daef0c5"
}
}