Create a service account, with or without a first token whose secret is shown once

POST

api

service-accounts

curl --request POST \
  --url https://api.nitsor.com/api/v1/service-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountPermissions": [],
  "idempotencyKey": "<string>",
  "name": "<string>",
  "description": "<string>",
  "firstToken": {
    "expiresAt": "2023-11-07T05:31:56Z",
    "expiresInDays": 7,
    "accountPermissions": [],
    "projects": [
      "<string>"
    ],
    "storageNote": "<string>",
    "name": "<string>"
  },
  "ownerEmail": "<string>",
  "ownerMembershipId": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/service-accounts"

payload = {
    "accountPermissions": [],
    "idempotencyKey": "<string>",
    "name": "<string>",
    "description": "<string>",
    "firstToken": {
        "expiresAt": "2023-11-07T05:31:56Z",
        "expiresInDays": 7,
        "accountPermissions": [],
        "projects": ["<string>"],
        "storageNote": "<string>",
        "name": "<string>"
    },
    "ownerEmail": "<string>",
    "ownerMembershipId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountPermissions: [],
    idempotencyKey: '<string>',
    name: '<string>',
    description: '<string>',
    firstToken: {
      expiresAt: '2023-11-07T05:31:56Z',
      expiresInDays: 7,
      accountPermissions: [],
      projects: ['<string>'],
      storageNote: '<string>',
      name: '<string>'
    },
    ownerEmail: '<string>',
    ownerMembershipId: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/service-accounts', 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.nitsor.com/api/v1/service-accounts",
  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([
    'accountPermissions' => [
        
    ],
    'idempotencyKey' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'firstToken' => [
        'expiresAt' => '2023-11-07T05:31:56Z',
        'expiresInDays' => 7,
        'accountPermissions' => [
                
        ],
        'projects' => [
                '<string>'
        ],
        'storageNote' => '<string>',
        'name' => '<string>'
    ],
    'ownerEmail' => '<string>',
    'ownerMembershipId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.nitsor.com/api/v1/service-accounts"

	payload := strings.NewReader("{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<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))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/service-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/service-accounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<string>\"\n}"

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

{
  "outcome": "created",
  "serviceAccount": {
    "accountPermissions": [
      "account:read"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "id": "<string>",
    "liveTokens": {
      "count": 1,
      "truncated": true,
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "soonestExpiresAt": "2023-11-07T05:31:56Z"
    },
    "name": "<string>",
    "projectGrants": {
      "count": 1,
      "truncated": true
    },
    "status": "active",
    "subject": "<string>",
    "description": "<string>",
    "disabledAt": "2023-11-07T05:31:56Z",
    "disabledBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "disabledReason": "<string>",
    "owner": {
      "active": true,
      "membershipId": "<string>",
      "email": "<string>",
      "leftAt": "2023-11-07T05:31:56Z",
      "name": "<string>"
    },
    "retiredAt": "2023-11-07T05:31:56Z",
    "retiredBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "retiredReason": "<string>"
  },
  "token": {
    "expiresAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "status": "active",
    "hint": "<string>",
    "secret": "<string>"
  }
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

No plan can call this operation today. It needs a personal access token, and Nitsor does not issue personal access tokens.

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Body

application/json

accountPermissions

enum<string>[]

required

Available options:

account:read,

account:update,

members:read,

members:write,

billing:read,

billing:write,

storage:read,

storage:write,

sources:register,

sources:browse,

notifications:read,

notifications:write,

projects:read,

projects:write,

work:contribute,

clearance:write,

service-accounts:manage

idempotencyKey

string

required

Required string length: 1 - 200

name

string

required

Required string length: 1 - 100

description

string

Maximum string length: 500

firstToken

object

A token minted with the service account. It can name no project: the service account is granted none until a project admin grants it, so projects is refused with token_restriction_ungranted. A caller whose own personal token is restricted to projects is refused the same way, since its first token would default to those projects. To give such a token, omit firstToken, create the service account, have a project admin grant it each project with POST /api/v1/projects/{id}/service-accounts, then add a token with POST /api/v1/service-accounts/{id}/tokens.

Show child attributes

ownerEmail

string

The address the owner signs in with, matched without regard to case against the account's active members. A request names its owner by this or by ownerMembershipId, never both.

Required string length: 3 - 320

ownerMembershipId

string

The owner's membership on the account. A request names its owner by this or by ownerEmail, never both.

Required string length: 1 - 200

Response

Create a service account, with or without a first token whose secret is shown once

outcome

enum<string>

required

Available options:

created,

replayed

serviceAccount

object

required

Show child attributes

token

object

Show child attributes

Create a service account, with or without a first token whose secret is shown once

curl --request POST \
  --url https://api.nitsor.com/api/v1/service-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountPermissions": [],
  "idempotencyKey": "<string>",
  "name": "<string>",
  "description": "<string>",
  "firstToken": {
    "expiresAt": "2023-11-07T05:31:56Z",
    "expiresInDays": 7,
    "accountPermissions": [],
    "projects": [
      "<string>"
    ],
    "storageNote": "<string>",
    "name": "<string>"
  },
  "ownerEmail": "<string>",
  "ownerMembershipId": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/service-accounts"

payload = {
    "accountPermissions": [],
    "idempotencyKey": "<string>",
    "name": "<string>",
    "description": "<string>",
    "firstToken": {
        "expiresAt": "2023-11-07T05:31:56Z",
        "expiresInDays": 7,
        "accountPermissions": [],
        "projects": ["<string>"],
        "storageNote": "<string>",
        "name": "<string>"
    },
    "ownerEmail": "<string>",
    "ownerMembershipId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountPermissions: [],
    idempotencyKey: '<string>',
    name: '<string>',
    description: '<string>',
    firstToken: {
      expiresAt: '2023-11-07T05:31:56Z',
      expiresInDays: 7,
      accountPermissions: [],
      projects: ['<string>'],
      storageNote: '<string>',
      name: '<string>'
    },
    ownerEmail: '<string>',
    ownerMembershipId: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/service-accounts', 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.nitsor.com/api/v1/service-accounts",
  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([
    'accountPermissions' => [
        
    ],
    'idempotencyKey' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'firstToken' => [
        'expiresAt' => '2023-11-07T05:31:56Z',
        'expiresInDays' => 7,
        'accountPermissions' => [
                
        ],
        'projects' => [
                '<string>'
        ],
        'storageNote' => '<string>',
        'name' => '<string>'
    ],
    'ownerEmail' => '<string>',
    'ownerMembershipId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.nitsor.com/api/v1/service-accounts"

	payload := strings.NewReader("{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<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))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/service-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/service-accounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountPermissions\": [],\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"firstToken\": {\n    \"expiresAt\": \"2023-11-07T05:31:56Z\",\n    \"expiresInDays\": 7,\n    \"accountPermissions\": [],\n    \"projects\": [\n      \"<string>\"\n    ],\n    \"storageNote\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"ownerEmail\": \"<string>\",\n  \"ownerMembershipId\": \"<string>\"\n}"

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

{
  "outcome": "created",
  "serviceAccount": {
    "accountPermissions": [
      "account:read"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "id": "<string>",
    "liveTokens": {
      "count": 1,
      "truncated": true,
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "soonestExpiresAt": "2023-11-07T05:31:56Z"
    },
    "name": "<string>",
    "projectGrants": {
      "count": 1,
      "truncated": true
    },
    "status": "active",
    "subject": "<string>",
    "description": "<string>",
    "disabledAt": "2023-11-07T05:31:56Z",
    "disabledBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "disabledReason": "<string>",
    "owner": {
      "active": true,
      "membershipId": "<string>",
      "email": "<string>",
      "leftAt": "2023-11-07T05:31:56Z",
      "name": "<string>"
    },
    "retiredAt": "2023-11-07T05:31:56Z",
    "retiredBy": {
      "issuer": "<string>",
      "subject": "<string>",
      "type": "system"
    },
    "retiredReason": "<string>"
  },
  "token": {
    "expiresAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "status": "active",
    "hint": "<string>",
    "secret": "<string>"
  }
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Reference

API operations

Create a service account, with or without a first token whose secret is shown once

Authorizations

Body

Response