Update Customer API
Learn more about the endpoint to update a customer, from the Customer Management API.
Update a customer record with this Customer Management API endpoint.
Request
PUT {oauth_uri}/customers/{customerId}Note: The
ROLE_ADMIN_CUSTOMER role is required for all endpoints of the Customer Management API.| Name | Required | Details |
|---|---|---|
| Authorization | Yes | Bearer <access_token> |
| Content-Type | Yes | application/json |
| Name | Required | Details |
|---|---|---|
| customerId | Yes | Identifier of the customer. |
Body
{
"id": "LocalTestOkta",
"tenants": [
"LocalTest"
],
"externalProviderConfig": [
{
"providerId": "OktaProvider",
"vendor": "okta",
"loginEndpoint": "https://reltiotest.okta.com/oauth2/v1/authorize",
"tokenEndpoint": "https://reltiotest.okta.com/oauth2/v1/token",
"userInfoEndpoint": "https://reltiotest.okta.com/oauth2/v1/userinfo",
"callbackEndpoint": "http://localhost:8080/oauth/callback",
"clientId": "F4k3npcnw9zcCcF022p6",
"clientSecret": "F4k33NIl4pk7LPOwdcXu_MBmeN8x77YP_iayBbIR",
"scope": "openid profile email",
"userIdMapping": "given_name",
"userEmailMapping": "email",
"userRoleMapping": "memberOf",
"userRoleRegexp": "(AZ_[a-zA-Z0-9_]*),*?",
"defaultNewUserRoleList": [
"ROLE_UI",
"ROLE_API",
"ROLE_USER",
"ROLE_ADMIN"
],
"tenants": [
"LocalTest",
"LocalTest2"
],
"jwt": false,
"sendClientCredentialsInBody": false
}
],
"description": "Customer via Okta",
"caseSensitiveLoginEnabled": false,
"applicationClients": [],
"customerSpecificRoles": [],
"customSettings": {
"jwtVersion": "V1"
}
} Response
{
"id": "LocalTestOkta",
"tenants": [
"LocalTest"
],
"externalProviderConfig": [
{
"providerId": "OktaProvider",
"vendor": "okta",
"loginEndpoint": "https://reltiotest.okta.com/oauth2/v1/authorize",
"tokenEndpoint": "https://reltiotest.okta.com/oauth2/v1/token",
"userInfoEndpoint": "https://reltiotest.okta.com/oauth2/v1/userinfo",
"callbackEndpoint": "http://localhost:8080/oauth/callback",
"clientId": "F4k3npcnw9zcCcF022p6",
"clientSecret": "F4k33NIl4pk7LPOwdcXu_MBmeN8x77YP_iayBbIR",
"scope": "openid profile email",
"userIdMapping": "given_name",
"userEmailMapping": "email",
"userRoleMapping": "memberOf",
"userRoleRegexp": "(AZ_[a-zA-Z0-9_]*),*?",
"defaultNewUserRoleList": [
"ROLE_UI",
"ROLE_API",
"ROLE_USER",
"ROLE_ADMIN"
],
"tenants": [
"LocalTest",
"LocalTest2"
],
"jwt": false,
"sendClientCredentialsInBody": false
}
],
"description": "Customer via Okta",
"caseSensitiveLoginEnabled": false,
"applicationClients": [],
"customerSpecificRoles": [],
"customSettings": {
"jwtVersion": "V1"
}
}