openapi: 3.2.0 info: contact: name: Mary Arem email: MARY.AREM@ADP.COM description: The Corporate Directory APIs return a list of corporate contacts or detailed information about a specific contact. Workers API response returns href URI as /wfn/hr/v1/corporate-contact-photos/{imageID.png}, for employees having contact photo. Consumer can retrieve the employee photo using this API.For more information please refer this guide Worker management guide for ADP WFN. title: Corporate Directory API version: 1.0.0 x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/hr/corporate-directory/v1/corporate-directory-swagger_v1-merged.json x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn) x-apievangelist-resource-path: hr/corporate-directory/v1/corporate-directory servers: - url: https://api.adp.com description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens' - url: https://api.eu.adp.com description: ADP European API gateway - url: https://uat-api.adp.com description: ADP UAT / sandbox gateway tags: - name: Corporate Directory description: List all corporate contacts paths: /{sor-id}/hr/v1/corporate-contact-photos/{image-id}.{image-extension}: x-adpPathData: uriTranslationIndicator: false featureCode: corporateDirectoryManagement functionCode: corporateDirectoryManagement serviceCode: organizationInformationManagement serviceCategoryCode: hr canonicalName: Corporate Directory get: summary: Corporate Contact Image x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobilePSSCorpDir - MobileESSCorpDir canonicalUri: hr/organizationInformationManagement/corporateDirectoryManagement/corporateDirectoryManagement/corporateDirectory.read sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationCode: corporateDirectory.read operationId: 2c062122-684c-49e2-a210-8b202b003a86 roleCodes: - practitioner - employee performAuthIndicator: true scenarios: - summary: Retrieve an employee corporate photo obtained in workers call. name: Retrieve an employees corporate photo responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: 'Retrieve an employee corporate photo obtained in Workers Call.This API returns photo Image Note-The API URI will be return in workers API response' description: Retrieve an employee corporate photo obtained in workers call. visibilityCodes: - internal globalViewDevPortalIndicator: false responses: '200': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Request an image of a contact '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '304': $ref: '#/components/responses/304' '403': $ref: '#/components/responses/403' '503': $ref: '#/components/responses/503' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' description: Request an image of a contact operationId: 2c062122-684c-49e2-a210-8b202b003a86 parameters: - schema: default: '' type: string in: header name: ADP-Acting-SessionID description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: ISI type: string in: header name: realm description: The identity Management Realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions x-adpParameterData: visibilityCodes: - internal required: true - schema: default: wfn-us type: string in: path name: sor-id description: SOR ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: If-None-Match description: Used with a method to make it conditional; the method is performed only if the client entity (via the given entity tag, ETag header) does not match the server entity. x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: path name: image-extension description: Image Extension x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ConsumerAppOID description: Identifier for the service consumer application. This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: CONSUMEROOID description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer application belongs. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: G4O73G9Z62SL2NFM type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: CONSUMERAOID description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming the Web API. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: path name: image-id description: Image ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: ADP-Act-As-AssociateOID description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.' x-adpParameterData: visibilityCodes: - internal - external required: true tags: - Corporate Directory components: responses: '429': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Too Many Requests content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '403': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Forbidden content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '500': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Internal Server Error content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '404': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Not Found content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '304': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Not Modified '503': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Service Unavailable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '400': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Bad Request content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '413': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale. Session ID for the acting session, Act-As and act On-Behalf-Off x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: Request Entity Too Large content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json x-adpSpecData: domain: HR specId: 9a7b50d0-cd54-4e69-8e83-3eec779c067d canonicalSpecId: a21cd9f7-ad18-4d15-b0f3-23914c0feb44 specStatusCode: published specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: corporate-directory-swagger_v1-merged.json serviceProviderId: 'null' resourcePath: hr/corporate-directory/v1 libraryVersion: '' businessRules: - rule: R11.0 ruleTitle: If clientProducts contains the SPNDACCTS product then the FSA feature is presented to the user. visibilityCodes: - internal - rule: R12.0 ruleTitle: 'If the feature.identifier.id=MobileESSCorpDir then the following featureConfig.code values MUST always be passed in the userProfile (i.e. When server builds the userProfile).Realm=GV,ESI1,ES2,ESI3Web application:directorySearchMode, valueTxt=truedirectorySearchMinChar ,valueTxt=1 and directorySearchLimit, valueTxt=101Native application:directorySearchMode, valueTxt=falsedirectorySearchMinChar ,valueTxt=1 and directorySearchLimit, valueTxt=101Realm=RUNNote: RUN serves the Small Business Unit. Clients have 1 to99 employees. This is never in search mode because we know that we will never have more than 100 entries in the directory.Web application:directorySearchMode=falsedirectorySearchMinChar ,valueTxt=3Native application:directorySearchMode=falsedirectorySearchMinChar ,valueTxt=3Realm=ADP IDMNote: ADP IDM is ADP the client. This is always in search mode because ADP the client is 40,000 employees so the Search is never sent to the SOR.Web application:directorySearchMode, valueTxt=true,directorySearchMinChar ,valueTxt=3Native application:directorySearchMode, valueTxt=true,directorySearchMinChar ,valueTxt=3Realm=ISIWeb application:directorySearchMode, valueTxt=true,directorySearchMinChar ,valueTxt=3Native application:directorySearchMode, valueTxt=false,directorySearchMinChar ,valueTxt=3' visibilityCodes: - internal - rule: R11.1 ruleTitle: If clientProducts does not contain the SPNDACCTS product, but the associateServiceAuthorization JSON contains MobileESSFSA then the FSA feature is shown to the user. visibilityCodes: - internal testCaseCollection: example: href: Worker Personal Profile.postman_collection.json description: Worker Personal Profile Postman Collection publicationContext: products: - productId: hcm-offrg-wfn productName: workforce now marketplaceProductName: ADP Workforce Now® specCategoryCode: ''