AM/FA/Inv - Enterprise Organization Update Whitelist

Details

/external/v1/org/{orgId}/whitelist

Synopsis

Enterprise Organization Update Whitelist

put

This route is used for an organization to update whitelist status.

This triggers an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.

This process will resolve domainName IPs and whitelist or blacklist on multiple infrastructure components.

This endpoint can be called by applications with access to scope "manageOrgs".

Authorizations

oauth2

Path parameters

orgIdanyRequired

The unique identifier of the organization on the blockchain

Example: US9QIMA

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. signer information and signature mechanism

Example: {"signer":{"email":"[email protected]","name":"John Doe"}}

whitelistbooleanRequired

This property if set "true" means that the organization being affected by this action will be able to access this organization's resources, like APIs, Peers, Orderers (if applicable).

"false" indicates that the organization affected by this action will stop being able to access aforementioned resources

Example: true

Responses

200

Successfully triggered the process to update whitelist status on the platform

The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned:

• GN0002

Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned:

• AU0001

• AU0003

Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned:

• AU0002

Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned:

• OG0013

• OG0002

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/org/{orgId}/whitelist HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "whitelist": true
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}