Update Administrator Security Settings
PUT {{apiPath}}/environments/{{envID}}/adminConfig
The PUT /environment/{{envID}}/adminConfig
operation updates the administrator sign-on configuration for the specified environment. In this request, the authenticationMethod
and policy.id
properties are being updated to use an external IdP for sign-on.
Property | Type | Required? |
---|---|---|
authenticationMethod | String | Required |
provider.id | UUID | Optional |
recovery | Boolean | Required |
See the Administrator security data model for full property descriptions.
Request Body
{"authenticationMethod"=>"EXTERNAL", "recovery"=>true, "provider"=>{"id"=>"d59c3dfe-f809-43db-bd0f-57f8ba536765"}}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/adminConfig"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"authenticationMethod":"EXTERNAL","recovery":true,"policy":{"id":"02cd5547-a749-4860-a524-29085a71eb07"},"provider":{"id":"d59c3dfe-f809-43db-bd0f-57f8ba536765"}}