Create a developer or service credential with one-time secret reveal

curl --request POST \
  --url https://api.firedrill.run/v1/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "actions": [],
  "expiresAtMs": 0,
  "projectId": "<string>"
}
'

import requests

url = "https://api.firedrill.run/v1/credentials"

payload = {
    "name": "<string>",
    "actions": [],
    "expiresAtMs": 0,
    "projectId": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', actions: [], expiresAtMs: 0, projectId: '<string>'})
};

fetch('https://api.firedrill.run/v1/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.firedrill.run/v1/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([
    'name' => '<string>',
    'actions' => [
        
    ],
    'expiresAtMs' => 0,
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.firedrill.run/v1/credentials"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://api.firedrill.run/v1/credentials")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firedrill.run/v1/credentials")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "credential": {
    "schemaVersion": 1,
    "credentialId": "<string>",
    "organizationId": "<string>",
    "kind": "browser",
    "subjectId": "<string>",
    "name": "<string>",
    "actions": [
      "profile.read"
    ],
    "keyPrefix": "<string>",
    "expiresAtMs": 0,
    "createdAtMs": 0,
    "projectId": "<string>",
    "revokedAtMs": 0,
    "lastUsedAtMs": 0
  },
  "secret": "<string>"
}

{
  "credential": {
    "schemaVersion": 1,
    "credentialId": "<string>",
    "organizationId": "<string>",
    "kind": "browser",
    "subjectId": "<string>",
    "name": "<string>",
    "actions": [
      "profile.read"
    ],
    "keyPrefix": "<string>",
    "expiresAtMs": 0,
    "createdAtMs": 0,
    "projectId": "<string>",
    "revokedAtMs": 0,
    "lastUsedAtMs": 0
  },
  "secret": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "source": "platform",
  "retryAfterMs": 123,
  "operationId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "details": {},
  "evidence": {
    "sessionId": "<string>",
    "runId": "<string>",
    "journalSeq": 4503599627370495,
    "buildHash": "<string>"
  }
}

Create a developer or service credential with one-time secret reveal

curl --request POST \
  --url https://api.firedrill.run/v1/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "actions": [],
  "expiresAtMs": 0,
  "projectId": "<string>"
}
'

import requests

url = "https://api.firedrill.run/v1/credentials"

payload = {
    "name": "<string>",
    "actions": [],
    "expiresAtMs": 0,
    "projectId": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', actions: [], expiresAtMs: 0, projectId: '<string>'})
};

fetch('https://api.firedrill.run/v1/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.firedrill.run/v1/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([
    'name' => '<string>',
    'actions' => [
        
    ],
    'expiresAtMs' => 0,
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.firedrill.run/v1/credentials"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://api.firedrill.run/v1/credentials")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firedrill.run/v1/credentials")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"actions\": [],\n  \"expiresAtMs\": 0,\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "credential": {
    "schemaVersion": 1,
    "credentialId": "<string>",
    "organizationId": "<string>",
    "kind": "browser",
    "subjectId": "<string>",
    "name": "<string>",
    "actions": [
      "profile.read"
    ],
    "keyPrefix": "<string>",
    "expiresAtMs": 0,
    "createdAtMs": 0,
    "projectId": "<string>",
    "revokedAtMs": 0,
    "lastUsedAtMs": 0
  },
  "secret": "<string>"
}

{
  "credential": {
    "schemaVersion": 1,
    "credentialId": "<string>",
    "organizationId": "<string>",
    "kind": "browser",
    "subjectId": "<string>",
    "name": "<string>",
    "actions": [
      "profile.read"
    ],
    "keyPrefix": "<string>",
    "expiresAtMs": 0,
    "createdAtMs": 0,
    "projectId": "<string>",
    "revokedAtMs": 0,
    "lastUsedAtMs": 0
  },
  "secret": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "source": "platform",
  "retryAfterMs": 123,
  "operationId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "details": {},
  "evidence": {
    "sessionId": "<string>",
    "runId": "<string>",
    "journalSeq": 4503599627370495,
    "buildHash": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Opaque control credential

Headers

Idempotency-Key

string

required

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json

kind

enum<string>

required

Available options:

developer,

service

name

string

required

Required string length: 1 - 100

Pattern: ^[^\r\n\t]+$

actions

enum<string>[]

required

Required array length: 1 - 128 elements

Available options:

profile.read,

profile.manage,

organization.read,

organization.manage,

organization.billing.read,

organization.billing.manage,

organization.audit.read,

organization.evidence.export,

organization.members.manage,

project.create,

project.read,

project.manage,

project.members.manage,

repository.read,

repository.connect,

repository.sync,

build.read,

build.publish,

environment.read,

environment.create,

environment.promote,

environment.archive,

session.read,

session.create,

session.control,

session.destroy,

drill.read,

drill.run,

run.read,

run.cancel,

run.compare,

evidence.read,

evidence.delete,

evidence.share,

evidence.export,

evidence.upload,

credential.manage,

tool.read,

tool.publish,

authoring.read,

authoring.run,

authoring.publish,

ci.execute

expiresAtMs

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

projectId

string

Pattern: ^prj_[0-9a-z]{12,32}$

Response

Idempotently replayed credential issue

credential

object

required

Show child attributes

secret

string

required

Pattern: ^fd_(?:dev|svc)_[A-Za-z0-9_-]{32,}$

Overview

Control API

Create a developer or service credential with one-time secret reveal

Authorizations

Headers

Body

Response