GET

Get the caller's Link permissions

Returns the calling user's effective Link permissions for the enterprise: the enterprise-wide bitgo.link.admin flag plus effective account-level admin / transfer / view scopes. Reveals only the caller's own permissions.

Path Params

enterpriseId string required

Your enterprise id.

at least 1 characters · matches ^[0-9a-f]{32}$

Header Params

user-id string required

User id of the user making the request.

at least 1 characters

Responses

200

Response Body

object

The calling user's Link permissions for one enterprise. Each account scope is the permission as resolved by UMS (UMS already includes implied grants — e.g. a link.account.admin/transfer grant carries the implied link.account.view), so consumers only need membership checks. bitgoLinkAdmin is a distinct enterprise-wide capability, reported separately and not folded into the scopes.

bitgoLinkAdmin boolean required

Enterprise-wide bitgo.link.admin grant. Drives non-account-scoped actions (e.g. "+ Link Account").
admin object

link.account.admin (manage) scope, as resolved by UMS. Omitted when the user has no admin grant.
ONE OF
- scope string enum required
  
  ALL
- accounts array of strings required
- scope string enum required
  
  LIMITED
transfer object

link.account.transfer scope, as resolved by UMS. Omitted when the user has no transfer grant.
ONE OF
- scope string enum required
  
  ALL
- accounts array of strings required
- scope string enum required
  
  LIMITED
view object

link.account.view scope, as resolved by UMS (includes accounts implied by admin/transfer grants). Omitted when none.
ONE OF
- scope string enum required
  
  ALL
- accounts array of strings required
- scope string enum required
  
  LIMITED

400

Bad Request

No response body

401

Unauthorized

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

500

Internal Server Error

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

curl -X GET \ --url 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/permissions' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string'

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/permissions'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/permissions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["user-id"] = 'string' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/permissions', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/permissions" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string" } response = requests.get(url, headers=headers) print(response.text)