Get service account by ID

GET

/api/security/serviceAccounts/{id}

const url = 'https://example.com/api/security/serviceAccounts/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/security/serviceAccounts/example \
  --header 'Authorization: Bearer <token>'

Retrieves a specific service account

Authorizations

bearerAuth

Parameters

Path Parameters

required

Service account ID

string

Responses

200

Service account retrieved successfully

application/json

object

required

Service account ID

string

secret

required

Service account secret — bcrypt hash in storage; the plaintext value is only returned once at creation time.

string

searchId

required

Searchable ID

string

name

required

Service account name

string

repos

Repository permissions

Array<object>

default:

object

CACHE_ROOT

required

Repository namespace

string

required

Repository ID

string

permission

required

Permission level (view, write, admin)

string

roles

Assigned roles

Array<string>

default:

groups

Group memberships

Array<string>

default:

type

Entity type

string

default: serviceAccount

description

Service account description

string

Example

{
  "id": "api-service",
  "searchId": "api-service",
  "name": "API Service",
  "repos": [],
  "roles": [],
  "groups": [],
  "type": "serviceAccount",
  "description": ""
}

404

Service account not found