vaults.grantVault

PUT

/v1/vaults/{vaultId}/bots/{botId}

curl --request PUT \
  --url https://example.com/v1/vaults/example/bots/example \
  --header 'Authorization: Bearer <token>'

Gives a Bot the right to use every item of a Vault in Code Mode. The caller must be able to use the Vault and to change the Bot.

Authorizations

• token
• session

Parameters

Path Parameters

vaultId

required

string

>= 1 characters <= 128 characters

botId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

Media typeapplication/json

object

vault

required

string

>= 1 characters <= 128 characters

bot

required

string

>= 1 characters <= 128 characters

grantedBy

required

string

grantedAt

required

number

Example ^generated

{
  "vault": "example",
  "bot": "example",
  "grantedBy": "example",
  "grantedAt": 1
}

400

VaultInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: VaultInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "VaultInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

VaultNotFound | VaultItemNotFound | SecretProviderNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: VaultNotFound

id

required

string

object

object

_tag

required

string

Allowed values: VaultItemNotFound

id

required

string

object

object

_tag

required

string

Allowed values: SecretProviderNotFound

id

required

string

Example

{
  "_tag": "VaultNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: SecretProviderInUse

id

required

string

object

object

_tag

required

string

Allowed values: VaultConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

SecretProviderFailed

Media typeapplication/json

object

_tag

required

string

Allowed values: SecretProviderFailed

message

required

string

Example

{
  "_tag": "SecretProviderFailed"
}

503

VaultsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: VaultsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}