View API Key

GET /personal-api-keys/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/personal-api-keys/{id}

Retrieves the details of a API Key.

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
company_idstring
The ID of the company, assigned by Ocamba API.
create_timedateTime
Timezone: GMT.


Example: 2021-11-25 13:45:03
descriptionstring
A more details about API key for easy identification.


Example: My API Key
end_timedateTime
Ending date and time for API Key. Timezone: GMT.


Example: 2024-11-25 13:45:03
idstring
API Key indentifier.


Example: 1001
issuer_idstring
The ID of the member, generated by the Ocamba, who issued API Key.


Example: 10001
member_idstring
The ID of the member, generated by the Ocamba.


Example: 10001
namestring
A descriptive name for the API key for easy identification.


Example: My API Key
secretstring
API Key.


Example: i01S296VTdPI00F3tPbONQ
start_timedateTime
Starting date and time for API Key. Timezone: GMT.


Example: 2021-11-25 13:45:03
statusstring
Api Key status.


Example: active

Possible values: active | pending | expired
update_timedateTime
Timezone: GMT.


Example: 2021-11-26 11:37:25
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 500
{
  "id": "1001",
  "issuer_id": "10001",
  "member_id": "10001",
  "name": "My API Key",
  "description": "My API Key",
  "status": "active",
  "secret": "i01S296VTdPI00F3tPbONQ",
  "end_time": "2024-11-25 13:45:03",
  "start_time": "2021-11-25 13:45:03",
  "create_time": "2021-11-25 13:45:03",
  "update_time": "2021-11-26 11:37:25"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}