Employee

List Employee

GEThttps://api.entro.security/v1/employees

Authorizations

AuthorizationstringRequired

Query parameters

limitintegerOptional

The maximum number of employees to return in the response. Can't be over 10000

Default: 1000

skipintegerOptional

The number of employees to skip before selecting data.

Default: 0

statusstringOptional

Employee status

divisionstringOptional

Employee division

organizationstringOptional

Employee organization

employeeTypestring · enumOptional

Employee type

Possible values: HUMAN APP UNKNOWN

azureEmployeeTypestringOptional

Employee Azure type

Responses

200Successful response

GET /v1/employees HTTP/1.1
Host: api.entro.security
Authorization: YOUR_API_KEY
Accept: */*

curl -L \
  --url 'https://api.entro.security/v1/employees' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Accept: */*'

const response = await fetch('https://api.entro.security/v1/employees', {
    method: 'GET',
    headers: {
      "Authorization": "YOUR_API_KEY",
      "Accept": "*/*"
    },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.entro.security/v1/employees",
    headers={"Authorization":"YOUR_API_KEY","Accept":"*/*"},
)

data = response.json()

{
  "employees": [
    {
      "fullName": "Adam Cheriki",
      "status": "ACTIVE",
      "division": "CTO",
      "organization": "Entro",
      "manager": null,
      "phone": null,
      "aliases": [
        "adam@entro.security"
      ],
      "ownerUid": "3213ea55-a05d-48b9-8330-ad684b0a6692",
      "email": "adam.cheriki@entro.security",
      "accounts": "[\"120798482511\",\"adam-testing-3\"]",
      "title": "Co-founder and Chief Technology Officer",
      "creationDate": "2023-06-07T07:51:20.000Z",
      "lastLogin": null,
      "idpSources": [
        "OKTA"
      ],
      "employeeType": "HUMAN",
      "azureEmployeeType": "Member"
    }
  ]
}

Get NHIs by Employee

GEThttps://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/nhis

Authorizations

AuthorizationstringRequired

Path parameters

EMPLOYEE_EMAILstringRequired

The employee email or alias.

Query parameters

skipintegerOptional

The number of NHIs to skip before selecting data.

Default: 0

limitintegerOptional

The maximum number of NHIs to return in the response. Can't be over 100

Default: 100

accountstringOptional

Filter for NHIs from specified account id

statusstringOptional

Filter for NHIs with specified status

identityTypestringOptional

Filter for NHIs with specified identity type

Responses

200Successful response

GET /v1/employee/{EMPLOYEE_EMAIL}/nhis HTTP/1.1
Host: api.entro.security
Authorization: YOUR_API_KEY
Accept: */*

curl -L \
  --url 'https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/nhis' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Accept: */*'

const response = await fetch('https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/nhis', {
    method: 'GET',
    headers: {
      "Authorization": "YOUR_API_KEY",
      "Accept": "*/*"
    },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/nhis",
    headers={"Authorization":"YOUR_API_KEY","Accept":"*/*"},
)

data = response.json()

{
  "employeeEmail": "employee@acme.com",
  "employeeAliases": [
    "employee@acme.co.uk"
  ],
  "employeeName": "Employee McEmployee",
  "isFormerEmployee": true,
  "nhis": [
    {
      "tokenId": "ABC123DEF456",
      "accountId": "github account id",
      "status": "Active",
      "accessedDate": "2024-01-01T16:12:42Z",
      "rotationDate": "2023-12-01T16:12:42Z",
      "identity": "DevUser",
      "identityType": "AWS Role"
    }
  ]
}

Get Exposed Secrets by Employee

GEThttps://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/exposedSecrets

Authorizations

AuthorizationstringRequired

Path parameters

EMPLOYEE_EMAILstringRequired

The employee email or alias.

Query parameters

skipintegerOptional

The number of Exposed Secrets to skip before selecting data.

Default: 0

limitintegerOptional

The maximum number of Exposed Secrets to return in the response. Can't be over 100

Default: 100

accountstringOptional

Filter for Exposed Secrets from specified account id

statusstring · enumOptional

Filter for Exposed Secrets with specified status

Possible values: INVALID ENABLED DISABLED UNSUPPORTED UNREACHABLE REVOKED

severitystring · enumOptional

Filter for Exposed Secrets with specified risk severity

Possible values: UNKNOWN LOW MEDIUM HIGH CRITICAL

exposedAtstring · enumOptional

Filter for Exposed Secrets with specified exposed at location.

Possible values: AWS_LAMBDA GCP_FUNCTION BITBUCKET_REPO_COMMIT AZURE_FUNCTION_APP AZURE_DEV_OPS_WIKI_PAGE AZURE_APP_CONFIGURATION GITHUB_REPO_COMMIT AWS_PARAMETER_STORE CONFLUENCE SLACK_CHANNEL JIRA MICROSOFT_TEAMS_CHANNEL AZURE_DEV_OPS_COMMIT GITHUB_ACTIONS_WORKFLOWS_LOG GITLAB_REPO_COMMIT FILES_SHARING_SMB SHAREPOINT GITHUB_PULL_REQUEST GITHUB_PULL_REQUEST_COMMENT BUILDKITE_BUILD_LOGS

Responses

200Successful response

GET /v1/employee/{EMPLOYEE_EMAIL}/exposedSecrets HTTP/1.1
Host: api.entro.security
Authorization: YOUR_API_KEY
Accept: */*

curl -L \
  --url 'https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/exposedSecrets' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Accept: */*'

const response = await fetch('https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/exposedSecrets', {
    method: 'GET',
    headers: {
      "Authorization": "YOUR_API_KEY",
      "Accept": "*/*"
    },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.entro.security/v1/employee/{EMPLOYEE_EMAIL}/exposedSecrets",
    headers={"Authorization":"YOUR_API_KEY","Accept":"*/*"},
)

data = response.json()

{
  "employeeEmail": "employee@acme.com",
  "employeeAliases": [
    "employee@acme.co.uk"
  ],
  "employeeName": "Employee McEmployee",
  "isFormerEmployee": true,
  "exposedSecrets": [
    {
      "exposedType": "GITHUB_TOKEN",
      "exposedAt": "GITHUB_PULL_REQUEST",
      "accountId": "github account id",
      "status": "ENABLED",
      "severity": "LOW",
      "exposurePath": "config/app.yml",
      "secretSnippet": "Password=1"
    }
  ]
}