PingOne Platform APIs

Step 1: Create a group

 

POST {{apiPath}}/environments/{{envID}}/groups

This example shows the POST {{apiPath}}/environments/{{envID}}/groups operation to create a new user group.

In this request:

  • {{envID}} represents your environment ID.

  • The request body requires the name property. The description property is optional.

  • The userFilter property defines a filter to dynamically add users to a group. In this case, the user’s type property is set to SAMLuser. The user is then assigned membership to this group automatically.

  • The request returns a Status: 201 created message and shows the new group’s configuration data.

  • The response data includes the group’s id property. This property value is needed to implement the accessControl feature in the SAML application.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
        "groupOwner": "Tom Jones",
        "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/groups' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
        "groupOwner": "Tom Jones",
        "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/groups")
{
  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"": ""SAML_Users{{$timestamp}}""," + "\n" +
@"    ""description"": ""SAML app users group""," + "\n" +
@"    ""customData"": {" + "\n" +
@"        ""groupOwner"": ""Tom Jones""," + "\n" +
@"        ""securityGroup"": true" + "\n" +
@"    }," + "\n" +
@"    ""userFilter"": ""type eq \""SAMLuser\""""" + "\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}}/groups"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
        "groupOwner": "Tom Jones",
        "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
}`)

  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}}/groups HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
        "groupOwner": "Tom Jones",
        "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"SAML_Users{{$timestamp}}\",\n    \"description\": \"SAML app users group\",\n    \"customData\": {\n        \"groupOwner\": \"Tom Jones\",\n        \"securityGroup\": true\n    },\n    \"userFilter\": \"type eq \\\"SAMLuser\\\"\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/groups")
  .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}}/groups",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
      "groupOwner": "Tom Jones",
      "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/groups',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "SAML_Users{{$timestamp}}",
    "description": "SAML app users group",
    "customData": {
      "groupOwner": "Tom Jones",
      "securityGroup": true
    },
    "userFilter": "type eq \"SAMLuser\""
  })

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

url = "{{apiPath}}/environments/{{envID}}/groups"

payload = json.dumps({
  "name": "SAML_Users{{$timestamp}}",
  "description": "SAML app users group",
  "customData": {
    "groupOwner": "Tom Jones",
    "securityGroup": True
  },
  "userFilter": "type eq \"SAMLuser\""
})
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}}/groups');
$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": "SAML_Users{{$timestamp}}",\n    "description": "SAML app users group",\n    "customData": {\n        "groupOwner": "Tom Jones",\n        "securityGroup": true\n    },\n    "userFilter": "type eq \\"SAMLuser\\""\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}}/groups")

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": "SAML_Users{{\$timestamp}}",
  "description": "SAML app users group",
  "customData": {
    "groupOwner": "Tom Jones",
    "securityGroup": true
  },
  "userFilter": "type eq \"SAMLuser\""
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"SAML_Users{{$timestamp}}\",\n    \"description\": \"SAML app users group\",\n    \"customData\": {\n        \"groupOwner\": \"Tom Jones\",\n        \"securityGroup\": true\n    },\n    \"userFilter\": \"type eq \\\"SAMLuser\\\"\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/groups")!,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/groups/f9e1ece2-f0f0-4375-9905-40ac30a6d0d0"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "allUserMembers": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22f9e1ece2-f0f0-4375-9905-40ac30a6d0d0%22%5D"
        },
        "directUserMembers": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22f9e1ece2-f0f0-4375-9905-40ac30a6d0d0%22%20and%20type%20eq%20%22DIRECT%22%5D"
        },
        "allGroupMembers": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22f9e1ece2-f0f0-4375-9905-40ac30a6d0d0%22%5D"
        },
        "directGroupMembers": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22f9e1ece2-f0f0-4375-9905-40ac30a6d0d0%22%20and%20type%20eq%20%22DIRECT%22%5D"
        }
    },
    "id": "f9e1ece2-f0f0-4375-9905-40ac30a6d0d0",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "SAML_Users1684260119",
    "description": "SAML app users group",
    "customData": {
        "groupOwner": "Tom Jones",
        "securityGroup": true
    },
    "createdAt": "2023-05-16T18:01:59.729Z",
    "updatedAt": "2023-05-16T18:01:59.729Z",
    "checkSum": "12843984986",
    "userFilter": "type eq \"SAMLuser\""
}