--- title: Create Sign-On Policy Action (AGREEMENT) description: The POST {{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions operation creates a new sign-on policy action resource. The agreement property specifies the ID for the agreement to which the user must provide (or deny) consent during sign-on. component: pingone-api page_id: pingone-api:platform:sign-on-policies/sign-on-policy-actions/create-sign-on-policy-action-agreement canonical_url: https://developer.pingidentity.com/pingone-api/platform/sign-on-policies/sign-on-policy-actions/create-sign-on-policy-action-agreement.html section_ids: prerequisites: Prerequisites headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Create Sign-On Policy Action (AGREEMENT) ## ```none POST {{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions ``` The `POST {{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions` operation creates a new sign-on policy action resource. The `agreement` property specifies the ID for the agreement to which the user must provide (or deny) consent during sign-on. | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The `condition` property for the sign-on policy action specifies the conditions associated with the action. At least one condition must be met to execute the action. If the `conditions` attribute is omitted from the sign-on policy action, the action is always executed. | The sample shows the a sign-on policy action with the `type` attribute set to `AGREEMENT`. ### Prerequisites * [Sign-on Policy Actions](../sign-on-policy-actions.html) * [Create a sign-on policy](../sign-on-policies-1/create-sign-on-policy.html) to get a `policyID` for the endpoint. * [Create an agreement](../../agreement-management/agreements-resources/create-agreement.html) to get an `agreementID` for the body. Refer also to [Agreement Management](../../agreement-management.html), especially [Agreements Resources](../../agreement-management/agreements-resources.html). > **Collapse: Request Model** > > | Property | Type | Required? | > | ----------- | ------- | --------- | > | `agreement` | String | Required | > | `priority` | Integer | Required | > | `type` | String | Required | > > Refer to the [Sign-on policy actions base data model](../sign-on-policy-actions.html#sign-on-policy-actions-base-data-model) for full property descriptions. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""priority"": 50," + "\n" + @" ""agreement"": {" + "\n" + @" ""id"": ""{{agreementID}}""" + "\n" + @" }," + "\n" + @" ""type"": ""AGREEMENT""" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions" method := "POST" payload := strings.NewReader(`{ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"priority\": 50,\n \"agreement\": {\n \"id\": \"{{agreementID}}\"\n },\n \"type\": \"AGREEMENT\"\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions" payload = json.dumps({ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer {{accessToken}}' )); $request->setBody('{\n "priority": 50,\n "agreement": {\n "id": "{{agreementID}}"\n },\n "type": "AGREEMENT"\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "priority": 50, "agreement": { "id": "{{agreementID}}" }, "type": "AGREEMENT" }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"priority\": 50,\n \"agreement\": {\n \"id\": \"{{agreementID}}\"\n },\n \"type\": \"AGREEMENT\"\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/signOnPolicies/{{policyID}}/actions")!,timeoutInterval: Double.infinity) request.addValue("application/json", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "POST" request.httpBody = postData let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 201 Created ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/c7f4211d-25c8-4f92-8e1f-396555875d11/actions/0198f203-5fef-47c1-b3e2-8b12e0c8b956" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "signOnPolicy": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/c7f4211d-25c8-4f92-8e1f-396555875d11" } }, "id": "0198f203-5fef-47c1-b3e2-8b12e0c8b956", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "type": "AGREEMENT", "signOnPolicy": { "id": "c7f4211d-25c8-4f92-8e1f-396555875d11" }, "priority": 50, "agreement": { "id": "8d1239bc-33c4-4ffb-bb4e-0cf1d938c93e" }, "disableDeclineOption": false } ```