Profile Management
Endpoint supporting the retrieval and editing of ICAP Profile settings.
/api/v1/profiles
Retrieves list of current ICAP Profiles.
/api/v1/profiles › Responses
OK
ProfileNameIdentifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
ProfileVersionIdentifies the version of the ICAP Profile.
IsDefaultProfile/api/v1/profiles/{profileName}
Retrieves the specified ICAP Profile settings.
path Parameters
profileNameSpecifies the name of the referenced ICAP Profile
Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
/api/v1/profiles/{profileName} › Responses
ICAP Profile found
ProfileNameIdentifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
ProfileIdentityProfileVersionIdentifies the version of the ICAP Profile.
IsDefaultProfileStatusStatus indicates whether ICAP Profile can be actively used.
The settings that are applied when the ICAP Policy is used.
/api/v1/profiles/{profileName}
Update ICAP Profile
Update the settings for an existing ICAP Profile.
path Parameters
profileNameSpecifies the name of the referenced ICAP Profile
Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
/api/v1/profiles/{profileName} › Request Body
The settings that are applied when the ICAP Policy is used.
StatusStatus indicates whether ICAP Profile can be actively used.
/api/v1/profiles/{profileName} › Responses
Profile updated
SchemaNameIdentifies the schema and its version. The format should be in the format of [name]v[version], consisting of only alphanumeric characters [A-Za-z0-9].
ProfileNameIdentifies the policy. The name should consist of only alphanumeric characters [A-Za-z0-9].
ProfileIdentityProfileVersionIdentifies the version of the ICAP Profile.
IsDefaultProfileProfileLocationStatusStatus indicates whether ICAP Profile can be actively used.
/api/v1/profiles/{profileName}
Creates a new ICAP profile
path Parameters
profileNameSpecifies the name of the referenced ICAP Profile
Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
/api/v1/profiles/{profileName} › Request Body
The settings that are applied when the ICAP Policy is used.
StatusStatus indicates whether ICAP Profile can be actively used.
/api/v1/profiles/{profileName} › Responses
Profile Created
SchemaNameIdentifies the schema and its version. The format should be in the format of [name]v[version], consisting of only alphanumeric characters [A-Za-z0-9].
ProfileNameIdentifies the policy. The name should consist of only alphanumeric characters [A-Za-z0-9].
ProfileIdentityProfileVersionIdentifies the version of the ICAP Profile.
IsDefaultProfileProfileLocationStatusStatus indicates whether ICAP Profile can be actively used.
/api/v1/profiles/{profileName}
Delete ICAP Profile
Delete the specified ICAP Profile
path Parameters
profileNameSpecifies the name of the referenced ICAP Profile
Identifies the ICAP Profile. The name should consist of only alphanumeric characters [A-Za-z0-9].
/api/v1/profiles/{profileName} › Responses
OK
/api/v1/profiles/{profileName}/reset
Resets Profile to schema defaults
Resets the settings for the specified profile to the default values in the profile schema. This applies to the 'default' profile also.
path Parameters
profileNameSpecifies the name of the referenced ICAP Profile
/api/v1/profiles/{profileName}/reset › Responses
Profile Updated