List service accounts for the current org

curl --request GET \
  --url https://api.nuon.co/v1/service-accounts \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.nuon.co/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.nuon.co/v1/service-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nuon.co/v1/service-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nuon.co/v1/service-accounts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "account_type": "auth",
    "created_at": "<string>",
    "email": "<string>",
    "id": "<string>",
    "managed_service_account": {
      "install_id": "<string>",
      "instance_key": "<string>",
      "owner_id": "<string>",
      "owner_name": "<string>",
      "owner_type": "<string>",
      "purpose": "<string>"
    },
    "name": "<string>",
    "org_ids": [
      "<string>"
    ],
    "permissions": {},
    "purposes": [
      "<string>"
    ],
    "roles": [
      {
        "applies_to": [
          "<string>"
        ],
        "createdBy": {
          "account_type": "auth",
          "created_at": "<string>",
          "email": "<string>",
          "id": "<string>",
          "name": "<string>",
          "org_ids": [
            "<string>"
          ],
          "permissions": {},
          "roles": "<array>",
          "subject": "<string>",
          "updated_at": "<string>",
          "user_journeys": [
            {
              "name": "<string>",
              "steps": [
                {
                  "complete": true,
                  "completed_at": "<string>",
                  "completion_method": "<string>",
                  "completion_source": "<string>",
                  "metadata": {},
                  "name": "<string>",
                  "title": "<string>"
                }
              ],
              "title": "<string>"
            }
          ]
        },
        "created_at": "<string>",
        "created_by_id": "<string>",
        "description": "<string>",
        "id": "<string>",
        "managed": true,
        "org_id": "<string>",
        "policies": [
          {
            "created_at": "<string>",
            "created_by_id": "<string>",
            "id": "<string>",
            "name": "org_admin",
            "permissions": {},
            "role_id": "<string>",
            "updated_at": "<string>"
          }
        ],
        "role_type": "org_admin",
        "title": "<string>",
        "updated_at": "<string>"
      }
    ],
    "subject": "<string>",
    "system_account": true,
    "updated_at": "<string>",
    "user_journeys": [
      {
        "name": "<string>",
        "steps": [
          {
            "complete": true,
            "completed_at": "<string>",
            "completion_method": "<string>",
            "completion_source": "<string>",
            "metadata": {},
            "name": "<string>",
            "title": "<string>"
          }
        ],
        "title": "<string>"
      }
    ]
  }
]

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

List service accounts for the current org

List the service accounts that belong to the current organization, along with their roles. Supports offset-based pagination.

Each account reports whether it is a system account, its purposes, and, for accounts managed by a resource, the owning resource.

management filters to user accounts, system accounts, or all. When set, it replaces include_runners and include_stacks.
purpose filters to accounts with that exact purpose.
q matches a case-insensitive substring of the account name, email, or ID, or of the owning resource’s name or ID.

GET

service-accounts

List service accounts for the current org

curl --request GET \
  --url https://api.nuon.co/v1/service-accounts \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.nuon.co/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.nuon.co/v1/service-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nuon.co/v1/service-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nuon.co/v1/service-accounts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "account_type": "auth",
    "created_at": "<string>",
    "email": "<string>",
    "id": "<string>",
    "managed_service_account": {
      "install_id": "<string>",
      "instance_key": "<string>",
      "owner_id": "<string>",
      "owner_name": "<string>",
      "owner_type": "<string>",
      "purpose": "<string>"
    },
    "name": "<string>",
    "org_ids": [
      "<string>"
    ],
    "permissions": {},
    "purposes": [
      "<string>"
    ],
    "roles": [
      {
        "applies_to": [
          "<string>"
        ],
        "createdBy": {
          "account_type": "auth",
          "created_at": "<string>",
          "email": "<string>",
          "id": "<string>",
          "name": "<string>",
          "org_ids": [
            "<string>"
          ],
          "permissions": {},
          "roles": "<array>",
          "subject": "<string>",
          "updated_at": "<string>",
          "user_journeys": [
            {
              "name": "<string>",
              "steps": [
                {
                  "complete": true,
                  "completed_at": "<string>",
                  "completion_method": "<string>",
                  "completion_source": "<string>",
                  "metadata": {},
                  "name": "<string>",
                  "title": "<string>"
                }
              ],
              "title": "<string>"
            }
          ]
        },
        "created_at": "<string>",
        "created_by_id": "<string>",
        "description": "<string>",
        "id": "<string>",
        "managed": true,
        "org_id": "<string>",
        "policies": [
          {
            "created_at": "<string>",
            "created_by_id": "<string>",
            "id": "<string>",
            "name": "org_admin",
            "permissions": {},
            "role_id": "<string>",
            "updated_at": "<string>"
          }
        ],
        "role_type": "org_admin",
        "title": "<string>",
        "updated_at": "<string>"
      }
    ],
    "subject": "<string>",
    "system_account": true,
    "updated_at": "<string>",
    "user_journeys": [
      {
        "name": "<string>",
        "steps": [
          {
            "complete": true,
            "completed_at": "<string>",
            "completion_method": "<string>",
            "completion_source": "<string>",
            "metadata": {},
            "name": "<string>",
            "title": "<string>"
          }
        ],
        "title": "<string>"
      }
    ]
  }
]

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

{
  "description": "<string>",
  "error": "<string>",
  "user_error": true
}

Authorizations

Authorization

string

header

required

Type "Bearer" followed by a space and token.

Query Parameters

offset

integer

default:0

offset of results to return

limit

integer

default:10

limit of results to return

page

integer

default:0

page number of results to return

include_runners

boolean

include service accounts with the runner role (excluded by default; ignored when management is set)

include_stacks

boolean

include service accounts with the stack role (excluded by default; ignored when management is set)

management

enum<string>

filter by who manages the account

Available options:

user,

system,

all

purpose

string

filter to service accounts with this exact purpose

string

case-insensitive substring match on name, email, ID, or owner name and ID

Response

account_type

enum<string>

Available options:

auth,

auth0,

service,

canary,

integration

created_at

string

managed_service_account

object

Show child attributes

name

string

org_ids

string[]

ReadOnly Fields

permissions

object

Show child attributes

purposes

string[]

roles

object[]

Show child attributes

subject

string

system_account

boolean

updated_at

string

user_journeys

object[]

Show child attributes

Cloud Reference

Interface Reference

Architecture Reference

List service accounts for the current org

Authorizations

Query Parameters

Response