/share-item

post https://api.akeyless.io/share-item

Body Params

accessibility

string

Defaults to regular

for personal password manager

action

string

required

Action to be performed on the item [start/stop/describe]

emails

array of strings

List of emails to start/stop sharing the secret with

emails

item-name

string

required

Item name

json

boolean

Defaults to false

Set output format to JSON

share-type

string

Defaults to email

Share type [email/token]

shared-token-id

array of strings

Shared token ids in order to stop sharing a secret

shared-token-id

token

string

Authentication token (see /auth and /configure)

ttl

int32

TTL of the Availability of the shared secret in seconds

uid-token

string

The universal identity token, Required only for universal_identity authentication

view-once

boolean

Defaults to false

ViewOnlyOnce Shared secrets can only be viewed once [true/false]

Responses

Language


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.akeyless.io/share-item \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "accessibility": "regular",
8
  "json": false,
9
  "share-type": "email",
10
  "view-once": false
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200shareItemResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.