Ctrl+K

Get session

get/api/v2/user/session

Returns the session associated with access token passed via the 'Authorization' header.

200 Response

session object required
bitgoAdminPermissions array[string]
The BitGo admin permissions associated with the access token
client string
The client associated with the access token
created string <date-time>
The creation date of the access token
enterprise string
The enterprise associated with the access token
expires string <date-time>
The expiration date of the access token
extensionAddress string
The extension address associated with the access token
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
internal boolean
ip string <ipv4>
IP address of the client that requested this access token
Example: 127.0.0.1
ipRestrict array[string]
IP addresses of clients that are allowed to use this token
isExtensible boolean required
Indicates if the access token is extensible
label string
The label associated with the access token
organizations array[string]
The organizations associated with the access token
origin string
BitGo environment that issued this token
Example: test.bitgo.com
token string
The token value
scope array[string]
Session permissions
Example: ["crypto_compare","user_manage","openid","profile","wallet_create","wallet_manage_all","wallet_approve_all","wallet_spend_all","wallet_edit_all","wallet_view_all"]
unlock object
The unlock object, returned if this session is currently unlocked
user string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
  "session": {
    "bitgoAdminPermissions": [
      "string"
    ],
    "client": "string",
    "created": "2019-08-24T14:15:22Z",
    "enterprise": "string",
    "expires": "2019-08-24T14:15:22Z",
    "extensionAddress": "string",
    "id": "59cd72485007a239fb00282ed480da1f",
    "internal": true,
    "ip": "127.0.0.1",
    "ipRestrict": [
      "string"
    ],
    "isExtensible": true,
    "label": "string",
    "organizations": [
      "string"
    ],
    "origin": "test.bitgo.com",
    "token": "string",
    "scope": [
      "crypto_compare",
      "user_manage",
      "openid",
      "profile",
      "wallet_create",
      "wallet_manage_all",
      "wallet_approve_all",
      "wallet_spend_all",
      "wallet_edit_all",
      "wallet_view_all"
    ],
    "unlock": {
      "spendingLimits": {
        "property1": {
          "txCount": 0,
          "txValue": 0,
          "txValueLimit": 0
        },
        "property2": {
          "txCount": 0,
          "txValue": 0,
          "txValueLimit": 0
        }
      },
      "expires": "2019-08-24T14:15:22Z",
      "time": "2019-08-24T14:15:22Z",
      "txCount": 0,
      "txValue": 0,
      "txValueLimit": 0
    },
    "user": "59cd72485007a239fb00282ed480da1f"
  }
}

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}