Ctrl+K

Get Internal Scoped User Session

get/api/v2/internal/user/scopedsession

Route to get internal scoped user session

Query Parameters

  • skipOAuthbooleanDefault: false
    Skip the SSO check that would throw 401 if the enterprise needs OAuth

200 Response

accessToken object required
The access token
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 or CIDR block 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}$
authenticationMetadata object required
The user authentication metadata
userId string required
The ID of the user
Min length: >= 1 characters
enterpriseContext object
The enterprise context of the user
organizationContext object
The organization context of the user
userContext object required
The user context
spooferContext object
The spoofer context
walletContext object
The wallet context (if any)

400 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