Get Access Key

Get Access Key

You must get an API key through a HTTP GET operation

Request
URI
GET
https://{api_host}//vrlic/api/v1/resources/access-keys/{keyId}
COPY
Path Parameters
string
keyId
Required

keyId is equals to orgId and access key name separated by a hyphen For eg. If access key name and orgId is access_key_1 and test_org_id respectively then keyId is csp_org_id-access_key_1

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AccessKey of type(s) */* 
{
    "name": "test-api-access-key",
    "key": "9KHY8TiNHOCmqTMkiCH55TwSdotS5",
    "orgId": "902932c-1274-4495-b7f5-a647f3c0908",
    "status": "ACTIVE",
    "link": "/vrlic/api/v1/resources/access-keys/902932c-1274-4495-b7f5-a647f3c0908-test-api-access-key",
    "version": 1,
    "createdBy": "[email protected]",
    "updatedAtInMicros": 1675332036007000,
    "customProperties": {
        "key": "value"
    }
}
string
name
Optional

Access key name

string
key
Optional

Access key

string
orgId
Optional

Unique OrgId based on user token

string
status
Optional

Access key status

Possible values are : ACTIVE, REVOKED,
string
link
Optional

Access key link

integer As int64 As int64
version
Optional

Access key version

integer As int64 As int64
updatedAtInMicros
Optional

Time in micros at which access key was updated

object
customProperties
Optional

Custom properties defined with an api key


On This Page
Access Keys Operations
POST
Create Access Key
DELETE
Delete Access Key
GET
Get Access Key
PATCH
Patch Access Key