ASasteroid
Secrets

Create Secret Request

Create a secret request. The item key is derived from name unless itemKey is given. 429 when the user exceeds the creation rate limit.

post/agents/v2/secret-requests

Request

  • Base URL
    https://odyssey.asteroid.ai
  • URL
    https://odyssey.asteroid.ai/agents/v2/secret-requests
  • Auth
    API key in header X-Api-Key

Request body

descriptionstring

Explanation shown to the recipient of the secret request.

itemKeystring

UPPER_SNAKE vault item key. Derived from name when omitted on create. Unique among a profile's attached items, not across the organisation. Stays the same across renames.

kind'login' | 'api_key' | 'card' | 'custom'

Kind of vault item. Templates and items need at least one field. Completeness is per-field required.

namestring required

Name of the secret the request creates.

organizationIdstring uuid
templateIdstring uuid
titlestring required

Title shown to the recipient of the secret request.

Response

The request has succeeded and a new resource has been created as a result.

recipientUrlstring required

Absolute URL of the page the recipient opens to submit the secret, on this environment's credential-request host. The token is in its fragment.

tokenstring required

Raw token for the recipient URL. Returned once.

Changes

No recorded changes to this operation across all 1 revision of this API.