addTestIdentitySource
The addTestIdentitySource operation handles configuration related to TestIdentitySource model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
identitySource | True | object | The ID of a identity source object that defines the identity source to be tested with the specified credentials Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
username | True | string | The username (present on the identity source) to be used in issuing an authentication request to the specified identity source Field level constraints: cannot be null, length must be between 0 and 128 (inclusive). (Note: Additional constraints might exist) |
|||
password | True | string | The password for the specified username Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
statusCode | False | integer | The status code is '200' only when the identity source responds with an access-accept message to the authentication request | |||
statusMessage | False | string | The status message is 'Successful' only when the identity source responds with an access-accept message to the authentication request | |||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
- name: Execute 'addTestIdentitySource' operation
ftd_configuration:
operation: "addTestIdentitySource"
data:
identitySource: "{{ identity_source }}"
username: "{{ username }}"
password: "{{ password }}"
statusCode: "{{ status_code }}"
statusMessage: "{{ status_message }}"
type: "{{ type }}"