PingOne Platform APIs

Identity Propagation Store Metadata (Slack)

 

POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack

The POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack endpoint returns metadata from the specified Slack identity store.

A request body is required but should be empty. Any content is ignored. Slack does not support dynamic metadata.

Prerequisites

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack")
{
  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 = @"{}";
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}}/propagation/storeMetadata/Slack"
  method := "POST"

  payload := strings.NewReader(`{}`)

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

{}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack")
  .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}}/propagation/storeMetadata/Slack",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({}),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({})

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

url = "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Slack"

payload = json.dumps({})
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}}/propagation/storeMetadata/Slack');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{}');
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}}/propagation/storeMetadata/Slack")

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({})

response = http.request(request)
puts response.read_body
let parameters = "{}"
let postData = parameters.data(using: .utf8)

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

200 OK

{
    "information": {
        "imageUrl": "https://assets.brandfolder.com/c8d4sd15/original/slack_rgb.png",
        "key": "Slack",
        "version": "2.0",
        "displayName": "Slack Connector",
        "identityProvider": true,
        "baseURLRequired": false,
        "connectionInformationRequired": true
    },
    "connectionProfiles": [
        {
            "name": "OAuth Bearer Token",
            "description": "Authentication Scheme using the OAuth Bearer Token Standard",
            "connectionAttributes": [
                {
                    "key": "OAUTH_ACCESS_TOKEN",
                    "displayLabel": "OAuth 2 Access Token",
                    "description": "OAuth 2 Access Token",
                    "required": true,
                    "sensitive": true
                },
                {
                    "key": "createNewUsers",
                    "displayLabel": "User Create",
                    "description": "User Create",
                    "required": false,
                    "typeBoolean": true,
                    "sensitive": false
                },
                {
                    "key": "updateNewUsers",
                    "displayLabel": "User Update",
                    "description": "User Update",
                    "required": false,
                    "typeBoolean": true,
                    "sensitive": false
                },
                {
                    "key": "disableNewUsers",
                    "displayLabel": "User Disable",
                    "description": "User Disable",
                    "required": false,
                    "typeBoolean": true,
                    "sensitive": false
                },
                {
                    "key": "UNIQUE_USER_IDENTIFIER",
                    "displayLabel": "Unique User Identifier",
                    "description": "Unique User Identifier",
                    "required": false,
                    "sensitive": false,
                    "possibleValues": [
                        "primaryEmail",
                        "userName"
                    ]
                },
                {
                    "key": "GROUP_MEMBERSHIP_HANDLING",
                    "displayLabel": "Group Membership Handling",
                    "description": "Merge or Overwrite existing members in Target Group (default is Overwrite)",
                    "required": false,
                    "sensitive": false,
                    "possibleValues": [
                        "Overwrite",
                        "Merge"
                    ]
                }
            ],
            "specUrl": "http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01",
            "documentationUrl": "http://example.com/help/oauth.html",
            "primary": false
        }
    ],
    "attributeMetadata": {
        "capabilities": [
            {
                "type": "DELETE_GROUPS",
                "maxResources": 1
            },
            {
                "type": "UPDATE_USERS",
                "maxResources": 1
            },
            {
                "type": "UPDATE_GROUPS",
                "maxResources": 1
            },
            {
                "type": "GET_CONNECTION_PROFILES",
                "maxResources": 1
            },
            {
                "type": "CREATE_GROUPS",
                "maxResources": 1
            },
            {
                "type": "CHECK_CONNECTION",
                "maxResources": 1
            },
            {
                "type": "CREATE_USERS",
                "maxResources": 1
            },
            {
                "type": "GET_USERS",
                "maxResources": 1
            },
            {
                "type": "GET_INFO",
                "maxResources": 1
            },
            {
                "type": "GET_GROUPS",
                "maxResources": 1
            },
            {
                "type": "GET_ATTRIBUTES",
                "maxResources": 1
            }
        ],
        "userAttributes": {
            "profileUrl": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "profileUrl",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "profileUrl",
                "referenceAttribute": [
                    "profile_url"
                ]
            },
            "country": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "country",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "country",
                "referenceAttribute": [
                    "work_country"
                ]
            },
            "preferredLanguage": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "preferredLanguage",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "preferredLanguage",
                "referenceAttribute": [
                    "language"
                ]
            },
            "displayName": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "displayName",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "displayName",
                "referenceAttribute": [
                    "display_name"
                ]
            },
            "timezone": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "timezone",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "timezone",
                "referenceAttribute": [
                    "timezone"
                ]
            },
            "postalCode": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "postalCode",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "postalCode",
                "referenceAttribute": [
                    "work_postal_code"
                ]
            },
            "roles": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "roles",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "roles"
            },
            "title": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "title",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "title",
                "referenceAttribute": [
                    "title"
                ]
            },
            "locale": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "locale",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "locale",
                "referenceAttribute": [
                    "locale"
                ]
            },
            "employeeNumber": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "employeeNumber",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "employeeNumber",
                "referenceAttribute": [
                    "employee_number"
                ]
            },
            "division": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "division",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "division",
                "referenceAttribute": [
                    "division"
                ]
            },
            "familyName": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "familyName",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "familyName",
                "referenceAttribute": [
                    "family_name"
                ]
            },
            "department": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "department",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "department",
                "referenceAttribute": [
                    "department"
                ]
            },
            "primaryEmail": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": true,
                "sensitive": false,
                "displayName": "primaryEmail",
                "requiredOnUpdate": false,
                "requiredOnCreate": true,
                "key": "primaryEmail",
                "referenceAttribute": [
                    "work_email"
                ]
            },
            "costCenter": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "costCenter",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "costCenter",
                "referenceAttribute": [
                    "cost_center"
                ]
            },
            "givenName": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "givenName",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "givenName",
                "referenceAttribute": [
                    "given_name"
                ]
            },
            "locality": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "locality",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "locality",
                "referenceAttribute": [
                    "work_city"
                ]
            },
            "active": {
                "type": "BOOLEAN",
                "attributeType": "BOOLEAN",
                "creatable": true,
                "updateable": true,
                "defaultedOnCreate": true,
                "unique": false,
                "sensitive": false,
                "displayName": "active",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "active",
                "defaultValue": true,
                "referenceAttribute": [
                    "active"
                ]
            },
            "honorificPrefix": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "honorificPrefix",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "honorificPrefix",
                "referenceAttribute": [
                    "name_prefix"
                ]
            },
            "userName": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": true,
                "sensitive": false,
                "displayName": "userName",
                "requiredOnUpdate": false,
                "requiredOnCreate": true,
                "key": "userName",
                "referenceAttribute": [
                    "username"
                ]
            },
            "profilePhotoUrl": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "profilePhotoUrl",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "profilePhotoUrl",
                "referenceAttribute": [
                    "photo_url"
                ]
            },
            "primaryPhone": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "primaryPhone",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "primaryPhone",
                "referenceAttribute": [
                    "work_phone"
                ]
            },
            "mobilePhone": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "mobilePhone",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "mobilePhone",
                "referenceAttribute": [
                    "mobile_phone"
                ]
            },
            "streetAddress": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "streetAddress",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "streetAddress",
                "referenceAttribute": [
                    "work_street_address"
                ]
            },
            "organization": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "organization",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "organization",
                "referenceAttribute": [
                    "organization"
                ]
            },
            "userType": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "userType",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "userType",
                "referenceAttribute": [
                    "user_type"
                ]
            },
            "region": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": false,
                "sensitive": false,
                "displayName": "region",
                "requiredOnUpdate": false,
                "requiredOnCreate": false,
                "key": "region",
                "referenceAttribute": [
                    "work_region"
                ]
            }
        },
        "groupAttributes": {
            "displayName": {
                "type": "STRING",
                "attributeType": "STRING",
                "creatable": true,
                "updateable": true,
                "unique": true,
                "sensitive": false,
                "displayName": "displayName",
                "requiredOnUpdate": true,
                "requiredOnCreate": true,
                "key": "displayName"
            }
        }
    },
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/Slack"
        }
    }
}