Qodex.ai

Identity Propagation Store Metadata (ServiceNow)

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

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

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

Prerequisites

RESPONSES

status: OK

{"information":{"imageUrl":"Image URL","key":"ServiceNow","version":"1.0.0.0-SNAPSHOT","displayName":"ServiceNow Connector","identityProvider":false,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"description":"Authentication Scheme using the Http Basic Standard","connectionAttributes":[{"key":"Administrator_Username","displayLabel":"Administrator Username","description":"Administrator Username","required":true,"sensitive":false},{"key":"Administrator_Password","displayLabel":"Administrator Password","description":"Administrator Password","required":true,"sensitive":true},{"key":"ServiceNow_Instance_Name","displayLabel":"ServiceNow Instance Name","description":"ServiceNow Instance Name","required":false,"sensitive":false},{"key":"ServiceNow_Url","displayLabel":"ServiceNow Url","description":"ServiceNow Url","required":true,"sensitive":false},{"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}],"specUrl":"http://www.ietf.org/rfc/rfc2617.txt","documentationUrl":"http://example.com/help/httpBasic.html","primary":false}],"attributeMetadata":{"capabilities":[{"type":"DELETE_USERS","maxResources":1},{"type":"CREATE_USERS","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"GET_ALL_USERS","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"CHECK_CONNECTION","maxResources":1}],"userAttributes":{"Zip":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Zip/Postal Code","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Zip","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["work_postal_code"]},"Timezone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Timezone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Timezone","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["timezone"]},"Email":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Email","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Email","caseSensitive":false,"maxLength":100,"minLength":0,"referenceAttribute":["work_email"]},"Photo":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Photo","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Photo","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["photo_url"]},"Prefix":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Prefix","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Prefix","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["name_prefix"]},"Gender":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Gender","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Gender","caseSensitive":false,"maxLength":40,"minLength":0},"Manager":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Manager","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Manager","caseSensitive":false,"maxLength":32,"minLength":0,"referenceAttribute":["manager_id"]},"MobilePhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Mobile Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"MobilePhone","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["mobile_phone"]},"Notification":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":true,"unique":false,"sensitive":false,"displayName":"Notification","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Notification","caseSensitive":true,"maxLength":40,"minLength":0,"defaultValue":"Enable"},"Department":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Department","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Department","caseSensitive":true,"maxLength":60,"minLength":0,"referenceAttribute":["department"]},"Language":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Language","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Language","caseSensitive":true,"maxLength":3,"minLength":0,"referenceAttribute":["language"]},"LockedOut":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"Locked Out","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"LockedOut","caseSensitive":false,"maxLength":40,"minLength":0,"defaultValue":"false"},"Street":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Street","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Street","caseSensitive":false,"maxLength":255,"minLength":0,"referenceAttribute":["work_street_address"]},"CountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Country Code","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"CountryCode","caseSensitive":true,"maxLength":3,"minLength":0,"referenceAttribute":["work_country"]},"Password":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":true,"displayName":"Password","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Password","caseSensitive":false,"maxLength":100,"minLength":0,"referenceAttribute":["password"]},"TimeFormat":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Time Format","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"TimeFormat","caseSensitive":false,"maxLength":40,"minLength":0},"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":0,"ordered":false,"key":"FirstName","caseSensitive":false,"maxLength":50,"minLength":1,"referenceAttribute":["given_name"]},"EmployeeNumber":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Employee Number","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"EmployeeNumber","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["employee_number"]},"Title":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Title","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Title","caseSensitive":false,"maxLength":60,"minLength":0,"referenceAttribute":["title"]},"active":{"type":"STRING","attributeType":"STRING","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","caseSensitive":false,"maxLength":40,"minLength":0,"defaultValue":"true","referenceAttribute":["active"]},"Roles":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Roles","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":2147483647,"minNumberOfValues":0,"ordered":false,"key":"Roles","caseSensitive":false,"maxLength":255,"minLength":0},"City":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"City","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"City","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["work_city"]},"MiddleName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Middle Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"MiddleName","caseSensitive":false,"maxLength":50,"minLength":0,"referenceAttribute":["middle_name"]},"HomePhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Home Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"HomePhone","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["home_phone"]},"Username":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":true,"sensitive":false,"displayName":"Username","requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Username","caseSensitive":false,"maxLength":100,"minLength":0,"referenceAttribute":["username"]},"State":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"State/Province","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"State","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["work_region"]},"PasswordNeedsReset":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"Password Needs Reset","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"PasswordNeedsReset","caseSensitive":false,"maxLength":40,"minLength":0,"defaultValue":"false"},"BusinessPhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Business Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"BusinessPhone","caseSensitive":false,"maxLength":40,"minLength":0,"referenceAttribute":["work_phone"]},"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":0,"ordered":false,"key":"LastName","caseSensitive":false,"maxLength":50,"minLength":1,"referenceAttribute":["family_name"]},"Location":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":true,"unique":false,"sensitive":false,"displayName":"Location","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"Location","caseSensitive":false,"maxLength":32,"minLength":0}},"groupAttributes":{"":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":true,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":true,"sensitive":false,"requiredOnUpdate":false,"requiredOnCreate":true,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"","caseSensitive":true,"maxLength":80,"minLength":0,"referenceAttribute":["display_name"]}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/ServiceNow"}}}