Input Parameters | ||||||
User | String The user name that will be used together with the Password parameter as authentication credentials for performing a request on an API. The credentials are stored in the approval request and passed to the API for completing the approval. This parameter is only visible to users with the CentraSite Administrator role. | |||||
Password | String The password that will be used together with the User parameter as authentication credentials. This parameter is only visible to users with the CentraSite Administrator role. | |||||
Approval Flow Name | String The name to be given to the approval workflow that this action initiates. This name serves to identify the workflow in the approver's Pending Approvals. An approval flow name can contain any combination of characters, including a space. You can also include substitution tokens in the name to incorporate data from the target object on which the policy is acting. For a list of the allowed tokens, see the list of Substitution Tokens shown in the Send Email Notification action. | |||||
Approver Group | String Array The user group (or groups) that identifies the set of users who are authorized to approve the requested operation.
| |||||
Approval is Needed From | String The manner in which the approval is to be processed: | |||||
Value | Description | |||||
AnyOne | Default The request can be approved or rejected by any single user in Approver Group. In this mode, only one user from the set of authorized approvers is required to approve or reject the request. | |||||
EveryOne | The request must be approved by all users specified in Approver Group. (It does not matter in which order the approvals are issued.) A single rejection will cause the request to be rejected. | |||||
Reject State | The lifecycle state that is to be assigned to the API if the approval request is rejected. If this parameter is not specified, the API's lifecycle state does not change when a rejection occurs. The lifecycle model must define a valid transition from the state that the target object is in at the time it is submitted for approval to the state specified in Reject State. Otherwise, the target object's state will not be switched when a rejection occurs. For more information about using this parameter, see the Switching the State of an Object
when an Approval Request is Rejected. | |||||
Send Pending Approval Email | Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is initially submitted for approval. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent.
| |||||
Users | Array of Users Users who are to receive the email.
| |||||
Groups | Array of Groups Groups whose users are to receive the email.
| |||||
Subject | String The text that you want to appear in the subject line of the email. This text can include substitution tokens to insert run-time data into the subject line. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action. | |||||
Use Email Template | Email Template Specifies the template that is to be used to generate the body of the email message. For more information about using email templates, see Predefined Email Templates Installed
with CentraSite
.
| |||||
Custom Message | TextArea The text of the email message. This text can include substitution tokens to insert run-time data into the message. For available tokens, see the list of Substitution Tokens shown in the Send Email Notification action.
| |||||
Format | String Specifies whether the message in the Custom Message parameter is formatted as HTML or plain text. | |||||
Include owner in notification | Boolean When the parameter is enabled, CentraSite sends the email to the provider of the API (on which the policy is acting) in addition to the other recipients. | |||||
Send Approval Email | Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is approved. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent.
| |||||
Users | See description of Users parameter above. | |||||
Groups | See description of Groups parameter above. | |||||
Subject | See description of Subject parameter above. | |||||
Use Email Template | See description of Use Email Template parameter above.
| |||||
Custom Message | See description of Custom Message parameter above. | |||||
Format | See description of Format parameter above. | |||||
Include owner in notification | See description of Include owner in notification parameter above. | |||||
Send Rejection Email | Boolean Specifies whether CentraSite is to send an email message to specified users and/or groups when the request is rejected. If you enable this option, you must set the following parameters to specify the text of the message and to whom it is to be sent.
| |||||
Users | See description of Users parameter above. | |||||
Groups | See description of Groups parameter above. | |||||
Subject | See description of Subject parameter above. | |||||
Use Email Template | See description of Use Email Template parameter above.
| |||||
Custom Message | See description of Custom Message parameter above. | |||||
Format | See description of Format parameter above. | |||||
Include owner in notification | See description of Include owner in notification parameter above. |