Identity Propagation Store Metadata (Workday)

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

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

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

Prerequisites

• See Identity Propagation (Provisioning) for important overview information.

RESPONSES

status: OK

{"information":{"imageUrl":"","key":"Workday","version":"1.0","displayName":"Workday Connector","identityProvider":false,"baseURLRequired":false,"connectionInformationRequired":false},"connectionProfiles":[{"connectionAttributes":[{"key":"username","displayLabel":"Username","description":"username","required":true,"typeBoolean":false,"sensitive":false},{"key":"password","displayLabel":"Password","description":"password","required":true,"typeBoolean":false,"sensitive":true},{"key":"tenantId","displayLabel":"Tenant ID","description":"tenantId","required":true,"typeBoolean":false,"sensitive":false},{"key":"host","displayLabel":"API Host","description":"host","required":true,"typeBoolean":false,"sensitive":false},{"key":"excludeInactiveWorkers","displayLabel":"Exclude Inactive Workers","description":"excludeInactiveWorkers","required":false,"typeBoolean":true,"sensitive":false},{"key":"excludeContingentWorkers","displayLabel":"Exclude Contingent Workers","description":"excludeContingentWorkers","required":false,"typeBoolean":true,"sensitive":false},{"key":"excludeEmployees","displayLabel":"Exclude Employees","description":"excludeEmployees","required":false,"typeBoolean":true,"sensitive":false}],"primary":false}],"attributeMetadata":{"capabilities":[{"type":"CHECK_CONNECTION","maxResources":1},{"type":"UPDATE_USERS","maxResources":1},{"type":"GET_ATTRIBUTES","maxResources":1},{"type":"GET_CONNECTION_PROFILES","maxResources":1},{"type":"GET_INFO","maxResources":1},{"type":"GET_USERS","maxResources":1},{"type":"GET_ALL_USERS","maxResources":1}],"userAttributes":{"lastName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"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":true,"referenceAttribute":["family_name"]},"businessUnit":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Business Unit","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":true,"key":"businessUnit","caseSensitive":true,"referenceAttribute":["division","department"]},"workStreetAddrLineTwo":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Street Address Line Two","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workStreetAddrLineTwo","caseSensitive":true},"workPostalCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Postal Code","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPostalCode","caseSensitive":true,"referenceAttribute":["work_postal_code"]},"homeFormattedAddress":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Formatted Address","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeFormattedAddress","caseSensitive":true,"referenceAttribute":["home_formatted_address"]},"workEmail":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Work Email","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workEmail","caseSensitive":true,"referenceAttribute":["work_email"]},"jobTitle":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"User ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"jobTitle","caseSensitive":true,"referenceAttribute":["title"]},"formattedName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Formatted Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":true,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"formattedName","caseSensitive":true,"referenceAttribute":["formatted_name"]},"homeCountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Country","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-1 Alpha-3 Code","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeCountryCode","caseSensitive":true,"referenceAttribute":["home_country"]},"homePhoneType":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"picklistValues":["Telephone","Mobile","Fax","Pager","VOIP"],"sensitive":true,"displayName":"Home Phone Type","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homePhoneType","caseSensitive":true},"wid":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":false,"displayName":"WID","requiredOnUpdate":true,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"wid","caseSensitive":true,"referenceAttribute":["id"]},"universalId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":true,"displayName":"Universal ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"universalId","caseSensitive":true},"company":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Cost Center","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":true,"key":"company","caseSensitive":true,"referenceAttribute":["cost_center"]},"terminated":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Terminated","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"terminated"},"homeLocality":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home City","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeLocality","caseSensitive":true,"referenceAttribute":["home_city"]},"workPhoneType":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"picklistValues":["Telephone","Mobile","Fax","Pager","VOIP"],"sensitive":true,"displayName":"Work Phone Type","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPhoneType","caseSensitive":true},"manager":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Manager ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"manager","caseSensitive":true,"referenceAttribute":["manager_id"]},"workLocality":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work City","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workLocality","caseSensitive":true,"referenceAttribute":["work_city"]},"homeStreetAddrLineTwo":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Street Address Line Two","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeStreetAddrLineTwo","caseSensitive":true,"referenceAttribute":["home_street_address"]},"homePhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Home Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homePhone","caseSensitive":true,"referenceAttribute":["home_phone"]},"active":{"type":"BOOLEAN","attributeType":"BOOLEAN","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Active","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"active","referenceAttribute":["active"]},"employeeId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":true,"displayName":"Employee ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"employeeId","caseSensitive":true,"referenceAttribute":["employee_number"]},"workFormattedAddress":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Formatted Address","requiredOnUpdate":false,"requiredOnCreate":false,"derived":true,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workFormattedAddress","caseSensitive":true,"referenceAttribute":["work_formatted_address"]},"userId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":true,"displayName":"User ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"userId","caseSensitive":true},"homeRegionCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Region","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-2 Code","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeRegionCode","caseSensitive":true,"referenceAttribute":["home_region"]},"homePostalCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Postal Code","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homePostalCode","caseSensitive":true,"referenceAttribute":["home_postal_code"]},"workPhoneCountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Work Phone Country","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"Country_Phone_Code_ID","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPhoneCountryCode","caseSensitive":true},"firstName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"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":true,"referenceAttribute":["given_name"]},"workRegionCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Region","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-2 Code","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workRegionCode","caseSensitive":true,"referenceAttribute":["work_region"]},"homeEmail":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Home Email","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeEmail","caseSensitive":true,"referenceAttribute":["home_email"]},"homePhoneCountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Home Phone Country","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"Country_Phone_Code_ID","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homePhoneCountryCode","caseSensitive":true},"workCountryCode":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Country","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-1 Alpha-3 Code","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workCountryCode","caseSensitive":true,"referenceAttribute":["work_country"]},"supervisoryOrg":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Supervisory Organization","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":true,"key":"supervisoryOrg","caseSensitive":true},"nameLocaleValue":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Name Locale","requiredOnUpdate":false,"requiredOnCreate":false,"standard":"ISO 3166-1 Alpha-3 Code","derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"nameLocaleValue","caseSensitive":true},"middleName":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Middle Name","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"middleName","caseSensitive":true,"referenceAttribute":["middle_name"]},"workStreetAddrLineOne":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Work Street Address Line One","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workStreetAddrLineOne","caseSensitive":true,"referenceAttribute":["work_street_address"]},"workPhone":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Work Phone","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"workPhone","caseSensitive":true,"referenceAttribute":["work_phone"]},"userType":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":false,"sensitive":false,"displayName":"User Type","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"userType","caseSensitive":true,"referenceAttribute":["user_type"]},"contingentWorkerId":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":true,"creatable":false,"updateable":false,"defaultedOnCreate":true,"nillable":false,"unique":true,"sensitive":true,"displayName":"Contingent Worker ID","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"contingentWorkerId","caseSensitive":true},"homeStreetAddrLineOne":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":true,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":false,"displayName":"Home Street Address Line One","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":0,"ordered":false,"key":"homeStreetAddrLineOne","caseSensitive":true,"referenceAttribute":["home_street_address"]},"username":{"type":"STRING","attributeType":"STRING","distinguishingAttribute":false,"creatable":false,"updateable":false,"defaultedOnCreate":false,"nillable":false,"unique":false,"sensitive":true,"displayName":"Username","requiredOnUpdate":false,"requiredOnCreate":false,"derived":false,"maxNumberOfValues":1,"minNumberOfValues":1,"ordered":false,"key":"username","caseSensitive":true,"referenceAttribute":["username"]}}},"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/Workday"}}}