ReferenceService Accounts
ResourcesService Accounts

Service Accounts

List service accounts

GET
/api/v1/orgs/{owner}/sa

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/sa"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "live_state": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "scopes": [        "string"      ],      "services": [        "string"      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create service account

POST
/api/v1/orgs/{owner}/sa

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

ServiceAccount body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/sa" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "live_state": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "services": [    "string"  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List service accounts names

GET
/api/v1/orgs/{owner}/sa/names

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/sa/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "live_state": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "scopes": [        "string"      ],      "services": [        "string"      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create service account token

POST
/api/v1/orgs/{owner}/sa/{entity}/tokens

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/sa/string/tokens" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch service account token

PATCH
/api/v1/orgs/{owner}/sa/{entity}/tokens/{token.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity

token.uuid*string

UUID

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/sa/string/tokens/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update service account token

PUT
/api/v1/orgs/{owner}/sa/{entity}/tokens/{token.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity

token.uuid*string

UUID

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/sa/string/tokens/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get service account token

GET
/api/v1/orgs/{owner}/sa/{entity}/tokens/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/sa/string/tokens/string"
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete service account token

DELETE
/api/v1/orgs/{owner}/sa/{entity}/tokens/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/sa/string/tokens/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch service account

PATCH
/api/v1/orgs/{owner}/sa/{sa.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

sa.uuid*string

UUID

Request Body

application/json

ServiceAccount body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/sa/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "live_state": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "services": [    "string"  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update service account

PUT
/api/v1/orgs/{owner}/sa/{sa.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

sa.uuid*string

UUID

Request Body

application/json

ServiceAccount body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/sa/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "live_state": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "services": [    "string"  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get service account

GET
/api/v1/orgs/{owner}/sa/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/sa/string"
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "live_state": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "services": [    "string"  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete service account

DELETE
/api/v1/orgs/{owner}/sa/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/sa/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List service account tokens

GET
/api/v1/orgs/{owner}/sa/{uuid}/tokens

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

SubEntity uuid

Query Parameters

entity?string

Entity name under namespace.

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/sa/string/tokens"
{  "count": 0,  "results": [    {      "uuid": "string",      "key": "string",      "name": "string",      "scopes": [        "string"      ],      "services": [        "string"      ],      "started_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "expiration": 0    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Presets
Searches

On this page

List service accountsCreate service accountList service accounts namesCreate service account tokenPatch service account tokenUpdate service account tokenGet service account tokenDelete service account tokenPatch service accountUpdate service accountGet service accountDelete service accountList service account tokens

Actions

Give us feedback