POST

Activate Link for an organization

Idempotent: finds the organization's existing "Link Manager" role or creates it (permissions bitgo.link.admin, link.account.admin, link.account.transfer, link.account.view, enterprise.view, scoped to all enterprises): an existing matching role is reused, otherwise the role is created via Roles & Permissions, bypassing the pending-approval flow. When the optional userIds is non-empty, those users are assigned to the role the same way, and the response carries the role's membership after the assignment. Requires the caller to be an organization admin.

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

Body Params

object

Activation details. The body may be empty ({}) to activate without assigning users.

userIds array of strings

Responses

201

Created

Response Body

object

Response for Link activation.

Carries the roleId of the organization's "Link Manager" role (reused when a matching role already exists, created otherwise). When the request assigned userIds, users carries the role's membership after the assignment; otherwise it is absent.

roleId string required
users array of objects
users object
- id string required
  
  The UMS id of the user record.
- userId string required
  
  The external user ID of the user.
  
  at least 1 characters
- userName string required
  
  The username of the user.
- status string required
  
  The status of the user.
  
  at least 1 characters
- firstName string
  
  The first name of the user (absent when unset).
- lastName string
  
  The last name of the user (absent when unset).

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

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' \
     --header 'content-type: application/json' \
     --data '{,"userIds":["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', 'content-type': 'application/json'},
  body: JSON.stringify({,"userIds":["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'
request["content-type"] = 'application/json'
request.body = '{,"userIds":["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',
    'content-type' => 'application/json',
  ],
  'body' => '{,"userIds":["string"]}',
]);

echo $response->getBody();

Request

import requests

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

payload = {,"userIds":["string"]}
headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "user-id": "string",
    "content-type": "application/json"
}

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

print(response.text)

Response

{
  "roleId": "string",
  "users": [
    {
      "id": "string",
      "userId": "string",
      "userName": "string",
      "status": "string",
      "firstName": "string",
      "lastName": "string"
    }
  ]
}

{}

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

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

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

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

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