POST

Activate Link for an organization

Creates the "Link Admin" role (permissions bitgo.link.admin, link.account.transfer, link.account.view, enterprise.view) for the enterprise's organization via Roles & Permissions. Requires the caller to be an organization admin; there is no request body.

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

201

Created

Response Body

object

Response for Link activation.

Carries the roleId of the "Link Admin" role created in the User Management Service.

roleId string required

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

403

Forbidden

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

404

Not Found

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

409

Conflict

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

422

Unprocessable Entity

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

Language

Credentials

Bearer

Request

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

Request

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/activation';
const options = {method: 'POST', 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));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/activation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["user-id"] = 'string'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/activation', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'user-id' => 'string',
  ],
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/activation"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "user-id": "string"
}

response = requests.post(url, headers=headers)

print(response.text)

Response

{
  "roleId": "string"
}

{}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}