Qodex.ai

Identity Propagation Store Metadata (GitHubEMU)

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

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

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

Prerequisites

RESPONSES

status: OK

{"information":{"imageUrl":"Image URL","key":"GitHubEMU","version":"1.0","displayName":"GitHub EMU Connector","identityProvider":false,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"name":"OAuth Bearer Token","description":"Authentication Scheme using the OAuth Bearer Token Standard","connectionAttributes":[{"key":"BASE_URL","displayLabel":"Base URL","description":"Base URL","required":true,"sensitive":false},{"key":"OAUTH_ACCESS_TOKEN","displayLabel":"OAuth 2 Access Token","description":"Access Token","required":true,"sensitive":true},{"key":"CREATE_USERS_PROV_OPT","displayLabel":"User Create","description":"User Create","required":false,"typeBoolean":true,"sensitive":false},{"key":"UPDATE_USERS_PROV_OPT","displayLabel":"User Update","description":"User Update","required":false,"typeBoolean":true,"sensitive":false},{"key":"REMOVE_USERS_PROV_OPT","displayLabel":"User Disable / Delete","description":"User Disable / Delete","required":false,"typeBoolean":true,"sensitive":false},{"key":"REMOVE_ACTION","displayLabel":"Remove User Action","description":"Remove User Action","required":false,"typeBoolean":false,"sensitive":false,"possibleValues":["Disable","Delete"]}],"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_ALL_GROUPS","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"DELETE_USERS","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"DELETE_GROUPS","maxResources":1},{"type":"UPDATE_GROUPS","maxResources":1},{"type":"CREATE_GROUPS","maxResources":1},{"type":"GET_GROUPS","maxResources":1},{"type":"GET_ALL_USERS","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1}],"enhancements":["MEMBERSHIP_AS_GROUP_ATTRIBUTE"],"userAttributes":{"lastName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Last Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"lastName","caseSensitive":false,"maxLength":255,"minLength":1,"referenceAttribute":["family_name"]},"firstName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"First Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"firstName","caseSensitive":false,"maxLength":255,"minLength":1,"referenceAttribute":["given_name"]},"workEmail":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Email","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"workEmail","caseSensitive":false,"maxLength":100,"minLength":1,"referenceAttribute":["work_email"]},"displayName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Display Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"displayName","caseSensitive":false,"maxLength":255,"minLength":1,"referenceAttribute":["display_name"]},"formattedName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Formatted Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"formattedName","caseSensitive":true,"maxLength":255,"minLength":0,"referenceAttribute":["formatted_name"]},"roles":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Roles","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":100,"minNumberOfValues":0,"ordered":false,"key":"roles","caseSensitive":false,"maxLength":50,"minLength":1,"referenceAttribute":["roles"]},"active":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"Active","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"active","defaultValue":true},"externalId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"External ID","requiredOnUpdate":true,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"externalId","caseSensitive":false,"maxLength":255,"minLength":0,"referenceAttribute":["external_id"]},"id":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"ID","requiredOnUpdate":true,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"id","caseSensitive":false,"maxLength":255,"minLength":0,"referenceAttribute":["id"]},"userName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"displayName":"Username","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"userName","caseSensitive":false,"maxLength":255,"minLength":1,"referenceAttribute":["username"]}},"groupAttributes":{"groupName":{"type":"STRING","attributeType":"STRING","creatable":true,"updateable":true,"unique":true,"sensitive":false,"displayName":"groupName","requiredOnUpdate":false,"requiredOnCreate":true,"key":"groupName"}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/GitHubEMU"}}}