Skip to main content
POST
/
api
/
v2
/
api-keys
CreateApiKey
curl --request POST \
  --url https://your-sift-api-url.com/api/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userId": "<string>"
}
'
{
  "apiKey": {
    "apiKeyId": "<string>",
    "name": "<string>",
    "key": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "userId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to ApiKeyService.CreateApiKey.

The request for a call to ApiKeyService.CreateApiKey.

​
name
string
required

The name for the new ApiKey. Required.

​
userId
string
required

Response

A successful response.

​
apiKey
CreatedApiKey includes the key, which will only be returned on creation, so having a separate type makes the "never return the key a second time" semantics clear · object
required