PingOne Platform APIs

Create Identity Provider Attribute (SAML)

   

POST {{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes

The POST {{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes operation adds a SAML identity provider attribute resource for the specified identity provider. Any placeholder is acceptable.

If SAML is specified as the the external identity provider, any SAML attribute defined in the assertion can be used as the mapping attribute placeholder value.

The placeholder value must use the following syntax:

${providerAttributes.<SAML attribute name>}

When you create a new SAML identity provider entity, the POST request automatically maps the PingOne username attribute to the SAML samlAssertion.subject attribute. The username attribute is the core mapping attribute; the default SAML attribute value is ${samlAssertion.subject}, which is a special reserved placeholder to refer to the subject name ID in the SAML assertion response.

SAML attributes can be mapped to any searchable PingOne user attribute, such as username, name.family, name.given, email, phone, externalId, or population.id.

The following sample shows the request body to map the PingOne externalId attribute to an externalId attribute defined in the SAML assertion.

{
	"name": "externalId",
	"value": "${providerAttributes.samlAssertion.externalId}",
	"update": "EMPTY_ONLY"
}

Refer to Identity Provider Attributes for more information. Refer also to Base IdP data model for the properties available to all of the supported identity providers.

Prerequisites

Request Model

SAML identity provider attribute settings data model

Property Type Required?

name

String

Required

value

String

Required

update

String

Required

SAML core attributes

Property Description

username

A string that specifies the core SAML attribute. The default value is ${samlAssertion.subject} and the default update value is EMPTY_ONLY.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes")
{
  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" +
@"    ""name"": ""externalId""," + "\n" +
@"    ""value"": ""${providerAttributes.externalId}""," + "\n" +
@"    ""update"": ""ALWAYS""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
}`)

  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))
}
POST /environments/{{envID}}/identityProviders/{{providerID}}/attributes HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"externalId\",\n    \"value\": \"${providerAttributes.externalId}\",\n    \"update\": \"ALWAYS\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes"

payload = json.dumps({
  "name": "externalId",
  "value": "${providerAttributes.externalId}",
  "update": "ALWAYS"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes');
$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    "name": "externalId",\n    "value": "${providerAttributes.externalId}",\n    "update": "ALWAYS"\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();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes")

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({
  "name": "externalId",
  "value": "\${providerAttributes.externalId}",
  "update": "ALWAYS"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"externalId\",\n    \"value\": \"${providerAttributes.externalId}\",\n    \"update\": \"ALWAYS\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}/attributes")!,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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/identityProviders/5cf3a911-174a-4d7a-8cc0-2d038a2de164/attributes/668d84f5-b848-4006-bb25-363214960c27"
        },
        "identityProvider": {
            "href": "https://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/identityProviders/5cf3a911-174a-4d7a-8cc0-2d038a2de164"
        }
    },
    "name": "externalId",
    "value": "${providerAttributes.externalId}",
    "update": "ALWAYS",
    "id": "668d84f5-b848-4006-bb25-363214960c27",
    "mappingType": "CUSTOM",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "identityProvider": {
        "id": "5cf3a911-174a-4d7a-8cc0-2d038a2de164"
    },
    "createdAt": 1559601707798,
    "updatedAt": 1559601707798
}