Qodex.ai

Identity Propagation Store Metadata (Slack)

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

The POST /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

RESPONSES

status: 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"]}],"specUrl":"http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01","documentationUrl":"http://example.com/help/oauth.html","primary":false}],"attributeMetadata":{"capabilities":[{"type":"GET_INFO","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"DELETE_GROUPS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"UPDATE_GROUPS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"CREATE_GROUPS","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"}}}