Skip to main content
POST
Create an API key.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request for the current user's API key. The request includes the required interactive confirmation.

Request to create an API key for the authenticated current user.

$type
enum<string>
required
Available options:
Derivitec.RiskPortal.Api.Models.CreateApiKeyModel, Derivitec.RiskPortal.Api
name
string | null

Name to assign to the new API key. The value must not be null or empty.

Example:

"Reporting integration"

description
string | null

Description to assign to the new API key. The value must not be null or empty.

Example:

"Synthetic key for a reporting workflow."

password
string | null

Password confirmation supplied for the API-key creation request.

mfa_token
string | null

Multi-factor authentication confirmation supplied for the API-key creation request.

Response

Created

Client-facing API-key record returned by list and create operations.

$type
enum<string>
required
Available options:
Derivitec.Aws.ApiGateway.Models.DerivitecExposedApiKey, Derivitec.Aws.ApiGateway
id
string | null

Opaque identifier used to select this API-key record.

name
string | null

Client-provided name assigned to the API key.

Example:

"Reporting integration"

exposed_value
string | null

API-key value returned with the client-facing record.