Get

Get

curl --request GET \
  --url https://devx.{environment}.oleria.io/v1/employees/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://devx.{environment}.oleria.io/v1/employees/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://devx.{environment}.oleria.io/v1/employees/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://devx.{environment}.oleria.io/v1/employees/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://devx.{environment}.oleria.io/v1/employees/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "employmentType": "Contingent Staff, Full-time",
  "id": "E232235",
  "objectMetadata": {
    "ApplicationInstanceId": "<string>",
    "GeneratedTime": "2023-11-07T05:31:56Z",
    "ObjectOrRelationshipType": "<string>"
  },
  "workName": "<string>",
  "globalId": "<string>",
  "oleriaObjectMetadata": {
    "enrichmentVersion": "<string>",
    "generatedTime": "2023-11-07T05:31:56Z"
  },
  "assignedLocations": [
    {
      "typeSpecificData": {
        "ipAddressExclusions": [
          "<string>"
        ],
        "ipAddressInclusions": [
          "<string>"
        ],
        "name": "<string>",
        "supplementaryInformation": {
          "geoLocation": {
            "latitude": 123,
            "longtitude": 123
          },
          "additionalLocationMetadata": [
            {
              "id": "<string>",
              "name": "<string>",
              "namespace": "<string>",
              "value": {}
            }
          ]
        }
      }
    }
  ],
  "authorizedLocations": {
    "isInherited": true,
    "policy": {
      "allowAll": true,
      "authorizedLocations": [
        {
          "typeSpecificData": {
            "ipAddressExclusions": [
              "<string>"
            ],
            "ipAddressInclusions": [
              "<string>"
            ],
            "name": "<string>",
            "supplementaryInformation": {
              "geoLocation": {
                "latitude": 123,
                "longtitude": 123
              },
              "additionalLocationMetadata": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "namespace": "<string>",
                  "value": {}
                }
              ]
            }
          }
        }
      ]
    }
  },
  "companyName": "Oleria Corporation",
  "costCenter": "232345",
  "createdDate": "2024-05-02T03:17:34.948Z",
  "employeeNumber": "K34312",
  "endDate": "2024-05-02T03:17:34.948Z",
  "identityProofs": [
    {
      "countryOfId": "<string>",
      "typeOfId": "<string>"
    }
  ],
  "jobCode": "343949",
  "jobFamily": "Software Engineering",
  "jobFamilyGroup": "Technology",
  "jobFunction": "Software Architect",
  "lastDateWorked": "2024-05-02T03:17:34.948Z",
  "lastModifiedDate": "2024-05-02T03:17:34.948Z",
  "objectDirectoryContainerFederation": {
    "isFederated": true,
    "authenticationKey": "<string>"
  },
  "objectDirectoryContainerId": "repo:R_kgDOLL0doQ (GitHub based on repository node identifier), 1BUxdX4M-H7X8GKRgTjprJS8fjY_Ij1giE82lQlny2kc (Google Drive based on file id)",
  "primaryWorkEmail": "kirt@oleria.com",
  "resignationSubmissionDate": "2023-11-07T05:31:56Z",
  "specialization": "Site Reliability",
  "startDate": "2024-05-02T03:17:34.948Z",
  "title": "Chief Architect",
  "workEmails": [
    "<string>"
  ],
  "globalAuthorizedLocations": {
    "isInherited": true,
    "policy": {
      "allowAll": true,
      "authorizedLocations": [
        {
          "typeSpecificData": {
            "ipAddressExclusions": [
              "<string>"
            ],
            "ipAddressInclusions": [
              "<string>"
            ],
            "name": "<string>",
            "supplementaryInformation": {
              "geoLocation": {
                "latitude": 123,
                "longtitude": 123
              },
              "additionalLocationMetadata": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "namespace": "<string>",
                  "value": {}
                }
              ]
            }
          }
        }
      ]
    }
  },
  "globalObjectDirectoryContainerId": "<string>",
  "enrichedNormalizedPrimaryWorkEmail": "<string>",
  "enrichedNormalizedWorkEmails": [
    "<string>"
  ],
  "sorPrimaryStewardEmail": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "The request was malformed."
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing or invalid authentication token."
}

{
  "code": "FORBIDDEN",
  "message": "The token lacks the required scope."
}

{
  "code": "NOT_FOUND",
  "message": "No resource with the given id."
}

{
  "code": "TOO_MANY_REQUESTS",
  "message": "Rate limit exceeded. Retry after the specified interval."
}

{
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred."
}

GET

employees

{id}

Get

curl --request GET \
  --url https://devx.{environment}.oleria.io/v1/employees/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://devx.{environment}.oleria.io/v1/employees/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://devx.{environment}.oleria.io/v1/employees/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://devx.{environment}.oleria.io/v1/employees/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://devx.{environment}.oleria.io/v1/employees/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "employmentType": "Contingent Staff, Full-time",
  "id": "E232235",
  "objectMetadata": {
    "ApplicationInstanceId": "<string>",
    "GeneratedTime": "2023-11-07T05:31:56Z",
    "ObjectOrRelationshipType": "<string>"
  },
  "workName": "<string>",
  "globalId": "<string>",
  "oleriaObjectMetadata": {
    "enrichmentVersion": "<string>",
    "generatedTime": "2023-11-07T05:31:56Z"
  },
  "assignedLocations": [
    {
      "typeSpecificData": {
        "ipAddressExclusions": [
          "<string>"
        ],
        "ipAddressInclusions": [
          "<string>"
        ],
        "name": "<string>",
        "supplementaryInformation": {
          "geoLocation": {
            "latitude": 123,
            "longtitude": 123
          },
          "additionalLocationMetadata": [
            {
              "id": "<string>",
              "name": "<string>",
              "namespace": "<string>",
              "value": {}
            }
          ]
        }
      }
    }
  ],
  "authorizedLocations": {
    "isInherited": true,
    "policy": {
      "allowAll": true,
      "authorizedLocations": [
        {
          "typeSpecificData": {
            "ipAddressExclusions": [
              "<string>"
            ],
            "ipAddressInclusions": [
              "<string>"
            ],
            "name": "<string>",
            "supplementaryInformation": {
              "geoLocation": {
                "latitude": 123,
                "longtitude": 123
              },
              "additionalLocationMetadata": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "namespace": "<string>",
                  "value": {}
                }
              ]
            }
          }
        }
      ]
    }
  },
  "companyName": "Oleria Corporation",
  "costCenter": "232345",
  "createdDate": "2024-05-02T03:17:34.948Z",
  "employeeNumber": "K34312",
  "endDate": "2024-05-02T03:17:34.948Z",
  "identityProofs": [
    {
      "countryOfId": "<string>",
      "typeOfId": "<string>"
    }
  ],
  "jobCode": "343949",
  "jobFamily": "Software Engineering",
  "jobFamilyGroup": "Technology",
  "jobFunction": "Software Architect",
  "lastDateWorked": "2024-05-02T03:17:34.948Z",
  "lastModifiedDate": "2024-05-02T03:17:34.948Z",
  "objectDirectoryContainerFederation": {
    "isFederated": true,
    "authenticationKey": "<string>"
  },
  "objectDirectoryContainerId": "repo:R_kgDOLL0doQ (GitHub based on repository node identifier), 1BUxdX4M-H7X8GKRgTjprJS8fjY_Ij1giE82lQlny2kc (Google Drive based on file id)",
  "primaryWorkEmail": "kirt@oleria.com",
  "resignationSubmissionDate": "2023-11-07T05:31:56Z",
  "specialization": "Site Reliability",
  "startDate": "2024-05-02T03:17:34.948Z",
  "title": "Chief Architect",
  "workEmails": [
    "<string>"
  ],
  "globalAuthorizedLocations": {
    "isInherited": true,
    "policy": {
      "allowAll": true,
      "authorizedLocations": [
        {
          "typeSpecificData": {
            "ipAddressExclusions": [
              "<string>"
            ],
            "ipAddressInclusions": [
              "<string>"
            ],
            "name": "<string>",
            "supplementaryInformation": {
              "geoLocation": {
                "latitude": 123,
                "longtitude": 123
              },
              "additionalLocationMetadata": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "namespace": "<string>",
                  "value": {}
                }
              ]
            }
          }
        }
      ]
    }
  },
  "globalObjectDirectoryContainerId": "<string>",
  "enrichedNormalizedPrimaryWorkEmail": "<string>",
  "enrichedNormalizedWorkEmails": [
    "<string>"
  ],
  "sorPrimaryStewardEmail": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "The request was malformed."
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing or invalid authentication token."
}

{
  "code": "FORBIDDEN",
  "message": "The token lacks the required scope."
}

{
  "code": "NOT_FOUND",
  "message": "No resource with the given id."
}

{
  "code": "TOO_MANY_REQUESTS",
  "message": "Rate limit exceeded. Retry after the specified interval."
}

{
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred."
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Path Parameters

string

required

Global id of the employee.

Response

The employee.

An Oleria Employee object represents an employment relationship between a human (Person) and a business. Employee records carry HR-sourced data including employment type, work email, organizational assignment, and lifecycle dates that are critical for access governance and offboarding workflows

employmentType

string

required

Business assigned employment type

Example:

"Contingent Staff, Full-time"

string

required

An identifier for an Employee object in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application id so connections to the object are robust to metadata changes and other relevant operations.

Example:

"E232235"

objectMetadata

object

required

The ObjectMetadata structure defines metadata that applies to every object and relationship, and is usually managed by the system that receives the data

Show child attributes

workName

string

required

Full name used for employment purposes

globalId

string

required

oleriaObjectMetadata

object

required

object metadata supersets object metadata with platform enrichment provenance — the enrichment version and the time the record was generated

Show child attributes

assignedLocations

object[]

These are the locations assigned as delivery points for this Employee

Show child attributes

authorizedLocations

object

AuthorizedLocationPolicy is used to specify locations authorized for use by accounts, groups, roles, employees, departments, etc.

Show child attributes

companyName

string

The official name of the employee's company

Example:

"Oleria Corporation"

costCenter

string

The cost center for the Employee

Example:

"232345"

createdDate

string<date-time>

The date the Employee object was created

Example:

"2024-05-02T03:17:34.948Z"

employeeNumber

string

Business assigned Employee number

Example:

"K34312"

endDate

string<date-time>

The Employee's end date at the business

Example:

"2024-05-02T03:17:34.948Z"

identityProofs

object[]

Show child attributes

jobCode

string

Identifier of the Employee's job or job profile, also known as the Job ID (Workday Job Code — the Job Profile's reference ID; SuccessFactors Job Classification code)

Example:

"343949"

jobFamily

string

The job family the Employee's job belongs to — a grouping of related jobs that share core knowledge and background requirements (Workday and SuccessFactors Job Family). Narrower than jobFamilyGroup and broader than specialization

Example:

"Software Engineering"

jobFamilyGroup

string

The broadest grouping of job families the Employee's job belongs to (Workday Job Family Group)

Example:

"Technology"

jobFunction

string

The functional role or occupation the Employee performs. A role-level descriptor, not a broad grouping — occupational groupings belong in jobFamily / jobFamilyGroup

Example:

"Software Architect"

lastDateWorked

string<date-time>

The Employee's last work date at the business (may be different from endDate)

Example:

"2024-05-02T03:17:34.948Z"

lastModifiedDate

string<date-time>

The date the Employee object was last modified

Example:

"2024-05-02T03:17:34.948Z"

objectDirectoryContainerFederation

object

Federation information used when specifying an EntityIdentifier

Show child attributes

objectDirectoryContainerId

string

An identifier (unique to the integrated application) for a ObjectDirectory object represented in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application or identity provider id so connections to the object are robust to metadata changes and other relevant operations

Example:

"repo:R_kgDOLL0doQ (GitHub based on repository node identifier), 1BUxdX4M-H7X8GKRgTjprJS8fjY_Ij1giE82lQlny2kc (Google Drive based on file id)"

primaryWorkEmail

string<email>

The primary email address of the Employee

Example:

"kirt@oleria.com"

resignationSubmissionDate

string<date-time>

The Employee's resignation date if applicable

specialization

string

A finer sub-discipline within the Employee's jobFamily. There is no standard Workday or SuccessFactors foundation field for this — it is sourced from an org-defined specialty or sub-classification. Not the Workday Job Category field, which is a regulatory/EEO classification. Distinct from the business title

Example:

"Site Reliability"

startDate

string<date-time>

The Employee's start date at the business

Example:

"2024-05-02T03:17:34.948Z"

title

string

The Employee's title

Example:

"Chief Architect"

workEmails

string[]

Array of work emails for the Employee (must include the primaryWorkEmail when present)

globalAuthorizedLocations

object

AuthorizedLocationPolicy is used to specify locations authorized for use by accounts, groups, roles, employees, departments, etc.

Show child attributes

globalObjectDirectoryContainerId

string

enrichedNormalizedPrimaryWorkEmail

string

Normalized version of the primary work email found in Employee.PrimaryWorkEmail

enrichedNormalizedWorkEmails

string[]

Normalized version of each work email found in Employee.WorkEmails

sorPrimaryStewardEmail

string

⌘I

Getting Started

Inventory & Actions

Action jobs

TrustFusion

Downloads

Authorizations

Path Parameters

Response