Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2023-06-23
Authenticate External Agents with an API Client

Authenticate External Agents with an API Client

Security:
Security Administration
 domain in the System functional area.
To register external agents, you need an access token in your ASOR API invocation. Below are the different options to obtain a token to invoke the ASOR API call.
The user registering the agent must have access to the
Setup: Agents
 domain in the Agent System of Record functional area to register an agent using the ASOR API.
  1. Access the
    Register API Client
     task.
  2. Complete the task:
    Option Description
    Client Name
    Enter a unique identifiable name for your agent. We recommend that you use a separate client for each agent so that they are easier to manage.
    Client Grant Type
    Select
    Authorization Code Grant.
    Access Token Type
    Select
    Bearer
    .
    Redirection URI
    Enter a URL to redirect users to after authorization.
    Scope (Functional Areas)
    Select
    Agent System of Record
    .
    Include Workday Owned Scope
    Select this check box.
  3. Copy and save the
    Client ID
     and
    Client Secret
     values.
    You can use these to get an access token to call the Definition API.
  4. Paste this URL into a new window.
    You'll be redirected to google.com with an appended code you can use to call the API:
    https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
  5. Create a new request using an external API Client.
    This generates an access token and refresh token that you can use to call the ASOR Agent Definition API. See External Agent ASU Considerations.
    1. Access
      https://<tenantHost>/ccx/oauth2/<tenantName>/token
    2. Create the request:
      Option
      Description
      Body
      grant_type=authorization_code&code=<authorizationCode>&client_id=<clientID>&client_secret=<ClientSecret>
      Username
      <ClientID>
      Password
      <ClientSecret>