GET
List scopes
Lists all scopes for a given policy rule.
Path Params
-
enterpriseIdstring requiredYour Enterprise Id.
Responses
200
All available scopes for your enterprise.
Response Body
object
Wrapper object for a list of scopes. Not paginated.
-
scopesarray of objectsA list of scopes available on your Enterprise.scopes object
-
idstring requiredUnique id of the scope. A UUID. -
namestring enum requiredName of the scope.wallet.segregated -
labelstring requiredA label for the scope which can be shown to an end user. -
descriptionstring requiredA description for the scope which can be shown to an end user. -
conditionsarray of objects requiredA list of Filtering Conditions the scope supports. For example the Wallet Type Filtering condition.ANY OF
-
namestring enum requiredThe name of the condition.wallet.type -
labelstring requiredA label for the condition which can be shown to an end user. -
descriptionstring requiredA description for the condition which can be shown to an end user. -
statusstring enum requiredStatus of the condition. Indicates if the condition is usable
ACTIVEor notINACTIVE.ACTIVE- The condition is available for use.INACTIVE- The condition is NOT available for use.
ACTIVEINACTIVE -
parametersarray of objects requiredA list of Parameters to control how the condition behaves.parameters object
-
namestring enum requiredThe name of the condition parameter.walletType -
labelstring requiredA description for the condition parameter which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter which can be shown to an end user. -
typestring enum requiredThis Conditions parameter has a set of defined values.ENUMERATED -
requiredstring enum requiredThis Conditions parameter must always be provided.ALWAYS -
allowMultipleboolean requiredtrue, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected. -
valuesarray of objects requiredA list of valid values, only values from this list will be accepted.ANY OF
- CustodialValue
- HotValue
- ColdValue
- TradingValue
- CustodialPairedValue
- BackingValue
No matching variants
-
valuestring enum requiredThe actual value.custodial -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
valuestring enum requiredThe actual value.hot -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
valuestring enum requiredThe actual value.cold -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
valuestring enum requiredThe actual value.trading -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
valuestring enum requiredThe actual value.custodialPaired -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
valuestring enum requiredThe actual value.backing -
labelstring requiredA label for the condition parameter Value which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter Value which can be shown to an end user.
-
-
namestring enum requiredThe name of the condition.wallet.ids -
labelstring requiredA label for the condition which can be shown to an end user. -
descriptionstring requiredA description for the condition which can be shown to an end user. -
statusstring enum requiredStatus of the condition. Indicates if the condition is usable
ACTIVEor notINACTIVE.ACTIVE- The condition is available for use.INACTIVE- The condition is NOT available for use.
ACTIVEINACTIVE -
parametersarray of objects requiredA list of Parameters to control how the condition behaves.parameters object
-
namestring enum requiredThe name of the condition parameter.walletId -
labelstring requiredA description for the condition parameter which can be shown to an end user. -
descriptionstring requiredA description for the condition parameter which can be shown to an end user. -
typestring enum requiredThe type of acceptable values for this condition parameter.BITGO_WALLET_ID -
requiredstring enum requiredThis Conditions parameter must always be provided.ALWAYS -
allowMultipleboolean requiredtrue, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
-
-
namestring enum requiredThe name of the condition.wallet.all -
labelstring requiredA label for the condition which can be shown to an end user. -
descriptionstring requiredA description for the condition which can be shown to an end user. -
statusstring enum requiredStatus of the condition. Indicates if the condition is usable
ACTIVEor notINACTIVE.ACTIVE- The condition is available for use.INACTIVE- The condition is NOT available for use.
ACTIVEINACTIVE
-
-
401
Unauthorized
Response Body
object
-
codestring -
messagestring -
statusinteger
403
Forbidden
Response Body
object
-
codestring -
messagestring -
statusinteger
404
The specified resource was not found
Response Body
object
-
codestring -
messagestring -
statusinteger
500
Server Error - Transient error please try again
Response Body
object
-
codestring -
messagestring -
statusinteger