The v1/roles endpoint will return a string of the role of the current API key. The response fields will be different for account-level and master-level API keys.
HEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOADstring·required
Base64-encoded JSON payload
Content-Typestring
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache
Request Body
requeststring·required
The literal string "/v1/roles"Example: /v1/roles
noncestring | integer·required
Gemini strongly recommends using milliseconds instead of seconds for timestamps.
Timestamp format
Example
Supported request type
string (seconds)
1495127793
POST only
string (milliseconds)
1495127793000
POST only
whole number (seconds)
1495127793
GET, POST
whole number (milliseconds)
1495127793000
GET, POST
Example: 1495127793000
Example request body
{
"request": "/v1/roles",
"nonce": "<nonce>"
}
Responses
The response will be a JSON object indicating the assigned roles to the set of API keys used to call `/v1/roles`. The `Auditor` role cannot be combined with other roles. `Fund Manager` and `Trader` can be combined.
isAuditorboolean·required
`True` if the Auditor role is assigned to the API keys. `False` otherwise.
isFundManagerboolean·required
`True` if the Fund Manager role is assigned to the API keys. `False` otherwise.
isTraderboolean·required
`True` if the Trader role is assigned to the API keys. `False` otherwise.
counterparty_idstring
_Only returned for master-level API keys_. The Gemini clearing counterparty ID associated with the API key making the request.
isAccountAdminboolean
_Only returned for master-level API keys_.`True` if the Administrator role is assigned to the API keys. `False` otherwise.
