Skip to main content
POST
/
api
/
v2
/
service-accounts
/
{id}
/
credentials
Create service account credential
curl --request POST \
  --url https://api.example.com/api/v2/service-accounts/{id}/credentials \
  --header 'Content-Type: application/json' \
  --data '
{
  "expirationDate": "2023-11-07T05:31:56Z",
  "scopes": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/api/v2/service-accounts/{id}/credentials"

payload = {
    "expirationDate": "2023-11-07T05:31:56Z",
    "scopes": ["<string>"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({expirationDate: '2023-11-07T05:31:56Z', scopes: ['<string>']})
};

fetch('https://api.example.com/api/v2/service-accounts/{id}/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v2/service-accounts/{id}/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expirationDate' => '2023-11-07T05:31:56Z',
    'scopes' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.example.com/api/v2/service-accounts/{id}/credentials"

	payload := strings.NewReader("{\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"scopes\": [\n    \"<string>\"\n  ]\n}")

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

	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))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/service-accounts/{id}/credentials")
  .header("Content-Type", "application/json")
  .body("{\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"scopes\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/service-accounts/{id}/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"scopes\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientSecret": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientSecretPrefix": "<string>",
    "expirationDate": "2023-11-07T05:31:56Z",
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "scopes": [
      "<string>"
    ]
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}

Path Parameters

id
string<uuid>
required

Body

application/json

Request to create an additional credential for an existing service account.

expirationDate
null | string<date-time>
scopes
null | string[]

The API scopes to grant to this credential.

Response

Created

Standard v2 API response envelope for single-item responses.

data
object

Returned only when a credential is created. Contains the plaintext client secret which is shown once.

meta
object