CreateApiKey - Sift

CreateApiKey

curl --request POST \
  --url https://api.siftstack.com/api/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userId": "<string>"
}
'

import requests

url = "https://api.siftstack.com/api/v2/api-keys"

payload = {
    "name": "<string>",
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v2/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "apiKey": {
    "apiKeyId": "<string>",
    "name": "<string>",
    "key": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "userId": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

/

api

/

v2

/

api-keys

CreateApiKey

curl --request POST \
  --url https://api.siftstack.com/api/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userId": "<string>"
}
'

import requests

url = "https://api.siftstack.com/api/v2/api-keys"

payload = {
    "name": "<string>",
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v2/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "apiKey": {
    "apiKeyId": "<string>",
    "name": "<string>",
    "key": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "userId": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<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

The id of the user the new key will authenticate as. Must equal the id of the calling user; creating an API key on behalf of another user is no longer supported and the service will return INVALID_ARGUMENT if the values differ. The field is retained for backwards compatibility with existing clients and may be marked deprecated in a future revision.

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

Show child attributes

⌘I