Tenant Management

How to request a new tenant

The tenant is created by the admin, for creating a new tenant please drop a mail at [email protected]

How to get an auth token for tenant API

curl -X 'POST' \
  'https://api.e-verify.openresumesolutions.com/api/v1/tenant/auth/token' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'username=<tenant_name>&password=<password>'

Get AUTH token

POST https://api.e-verify.openresumesolutions.com/api/v1/tenant/auth/token

Headers

Name

Type

Description

String

Content-Type

String

Request Body

Name

Type

Description

username*

String

password*

String

{
  "access_token": "<jwt token>",
  "token_type": "bearer"
}

How to change the tenant password

https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/reset-password

curl -X 'POST' \
  'https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/reset-password' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Authorization: Bearer <access_token>' \
  -d 'new_password=<new_password>'

POST https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/reset-password

Headers

Name

Type

Description

String

Content-Type

String

Authorization*

String

Request Body

Name

Type

Description

new_password*

String

{
  "username": "<username>",
  "email": "<email>",
  "disabled": false,
  "created_on": "2022-05-22T10:12:24.645Z",
  "updated_on": "2022-05-22T10:12:24.645Z"
}

Generate API Secret Key

curl -X 'POST' \
  'https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/api-secret-key/new?code=test_22_05_2022&expiry_on=2022-05-22%2016%3A02%3A05.119409' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <access_token>' \
  -d ''

POST https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/api-secret-key/new

Path Parameters

Name

Type

Description

code*

String

Human readable label to identify api key

expiry_on

String

datetime format for expiry key

Headers

Name

Type

Description

String

Authorization*

String

"{'code': 'test_22_05_2022', 'api_secret_key': '<api_secret_key>', 'expiry_on': '2022-05-22 16:02:05.119409'}"

"E11000 duplicate key error collection: everify.tenant_api_key index: index_unique_for_tenant_code dup key: { username: \"tenant_crif_highmark\", code: \"test_22_05_2022\" }, full error: {'index': 0, 'code': 11000, 'keyPattern': {'username': 1, 'code': 1}, 'keyValue': {'username': 'tenant_crif_highmark', 'code': 'test_22_05_2022'}, 'errmsg': 'E11000 duplicate key error collection: everify.tenant_api_key index: index_unique_for_tenant_code dup key: { username: \"tenant_crif_highmark\", code: \"test_22_05_2022\" }'}"

# if expiry_on incorrect datetime format e.g 2022-05-22

{
  "detail": [
    {
      "loc": [
        "query",
        "expiry_on"
      ],
      "msg": "invalid datetime format",
      "type": "value_error.datetime"
    }
  ]
}

How to validate the API key

curl -X 'GET' \
  'https://api.e-verify.openresumesolutions.com/api/v1/to-test-api-key' \
  -H 'accept: application/json' \
  -H 'api-secret-key: <api-secret-key>'

GET https://api.e-verify.openresumesolutions.com/api/v1/to-test-api-key

Headers

Name

Type

Description

String

api-secret-key*

String

"API Secret Key is valid and is it expired ? False"

How to revoke API Key

curl -X 'POST' \
  'https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/api-secret-key/revoke?code=test_22_05_2022' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <access_token>' \
  -d ''

POST https://api.e-verify.openresumesolutions.com/api/v1/tenant/me/api-secret-key/revoke

Headers

Name

Type

Description

String

Authorization*

String

"{'code': 'test_22_05_2022'}"

PreviousWhat is E-verify?NextHow to use API

Last updated 3 years ago