API Keys

An alternate way to access Telmai APIs using API Key.

All Telmai APIs can be executed either with OAuth access token or API keys. Use apis listed below to create a key. Use this key in the header of the Telmai APIs instead of the Authorization bearer token like this:

X-TLM-Key:{API Key}

Execute Authenticate API to retrieve access token for Authorization header used below

Tenant Id can be retrieved from the UI as listed here.

Retrieve API Keys for this tenant

GET https://env1.auth.telm.ai/auth/{tenant}/apiKeys

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization*	String	Bearer {{token}}

200: OK List of API Keys

{
    "keys": [
        {
            "id": "<id>",
            "name": "<api-key-name>",
            "key": "<api-key>"
        }
    ]
}

Add an API Key

POST https://env1.auth.telm.ai/auth/{tenant}/apiKeys

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization	String	Bearer {{token}}

Request Body

Name	Type	Description
name*	String	Name of the API Key

200: OK

{
    "id": "<api-key-id>",
    "name": "<api-key-name>",
    "key": "<api-key>"
}

Get details of an API Key

GET https://env1.auth.telm.ai/auth/{{tenant}}/apiKeys/{{apiKeyId}}

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization*	String	Bearer {{token}}

200: OK API key Details

{
    "id": "<api-key-id>",
    "name": "<api-key-name>",
    "key": "<api-key>",
    "created_by": "string",
    "created_on": "string"
}

Delete an API Key

DELETE https://env1.auth.telm.ai/auth/{{tenant}}/apiKeys/{{apiKeyId}}

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization*	String	Bearer {{token}}

200: OK

{
  {
    "message": "API key was deleted successfully"
}