passphrase

Download Spec

get /keyvault/api/v1/passphrase

Returns list of passphrase names.

Authorization

string

required

Default
"Basic base64-encoded-string"

Response

ExamplesSchema

Successful response, returns list of passphrase names.

{
  "count": 123,
  "items": [
    "string"
  ]
}

post /keyvault/api/v1/passphrase

Add new passphrase based on the given parameters.

name

string

ownerid

string

public

boolean

exportable

boolean

passphrase

string

Request

{
  "name": "string",
  "ownerid": "string",
  "public": true,
  "exportable": true,
  "passphrase": "string"
}

Response

ExamplesSchema

Passphrase created successfully.

{
  "name": "string",
  "ownerid": "string",
  "public": true,
  "exportable": true,
  "passphrase": "string"
}

post /keyvault/api/v1/passphrase/generate

Generate passphrase based on the given parameters.

size

int

type

string

Request

{
  "size": 123,
  "type": "string"
}

Response

ExamplesSchema

Passphrase generated successfully.

{
  "name": "string",
  "passphrase": "string"
}

get /keyvault/api/v1/passphrase/{name}

Return the passphrase matching the given name.

name

string

required

The passphrase name.

Response

ExamplesSchema

Successful response, returns passphrase.

{
  "name": "string",
  "passphrase": "string"
}

put /keyvault/api/v1/passphrase/{name}

Update the passphrase.

ownerid

string

public

boolean

exportable

boolean

passphrase

string

Request

{
  "ownerid": "string",
  "public": true,
  "exportable": true,
  "passphrase": "string"
}

Response

ExamplesSchema

Passphrase successfully updated.

{
  "name": "string",
  "ownerid": "string",
  "public": true,
  "exportable": true,
  "passphrase": "string"
}

delete /keyvault/api/v1/passphrase/{name}

Remove passphrase.

name

string

required

The passphrase name.

Response

ExamplesSchema

Passphrase successfully removed.

"string"

Was this page helpful?