authenticationProfile - Edit

Purpose

This API is used to edit an authentication profile by authentication profile ID.

HTTP Method

PUT

URL

https://app.infiniteblue.com/rest/api/authenticationProfile

URL Parameters

authProfileId

The authentication profile ID of the profile which has to be edited.

authProfileName

This is an optional parameter. Authentication profile name to update the existing authentication profile.

defaultUIAuth

This is an optional parameter. If set to true, the authentication profile which is being created will be set as customers default authentication.

defaultAPIAuth

This is an optional parameter. If set to true, the authentication profile which is being created will be set as customers default authentication.

Note: Remaining parameters are based on the type of authentication which ever is supported for setAuthentication API currently.

Permissions Required

Full administrative privileges.

Response

The authentication profile for the tenant in XML or JSON format.

Sample XML output:

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok">
<authProfileId>54d72c32-a2e1-4cb7-a6fe-58e336e50ac8</authProfileId>
<Msg>Authentication Profile has been updated successfully</Msg>
</resp>

Sample JSON output:

{
"authProfileId": "54d72c32-a2e1-4cb7-a6fe-58e336e50ac8",
"Msg": "Authentication Profile has been updated successfully"
}

Sample invalid responses 

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="fail">
<err>Authentication Profile with ID: 54d72cfd32-a2e1-4cb7-a6fe-58e336e50ac8 doesn't exist or cannot be deleted</err>
</resp>

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="fail">
<err>Global Authentications like Custom/Kerberos/API Token cannot be updated</err>
</resp>

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="fail">
<err>This authentication type cannot be set as default API authentication</err>
</resp>