vaults.createVault

POST

/v1/vaults

const url = 'https://example.com/v1/vaults';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","shared":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/vaults \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "shared": true }'

Authorizations

token
session

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

shared

boolean

Example ^generated

{
  "name": "example",
  "shared": true
}

Responses

201

Success

application/json

object

required

string

>= 1 characters <= 128 characters

name

required

string

owner

required

Any of:

object
object

object

_tag

required

string

Allowed values: Member

userId

required

string

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "owner": {
    "_tag": "Member"
  }
}

400

VaultInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: VaultInvalid

message

required

string

Example

{
  "_tag": "VaultInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

VaultNotFound | VaultItemNotFound | SecretProviderNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: VaultNotFound

required

string

Example

{
  "_tag": "VaultNotFound"
}

409

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

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

SecretProviderFailed

application/json

object

_tag

required

string

Allowed values: SecretProviderFailed

message

required

string

Example

{
  "_tag": "SecretProviderFailed"
}

503

VaultsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

vaults.createVault

Authorizations

Request Bodyrequired

Example generated

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

502

Example

503

Example

Request Body^required

Example ^generated