package api.v1.service_account

Get desktop application:
View/edit binary Protocol Buffers messages

The service to manage your Service Accounts

• rpc Create (CreateRequest, CreateResponse)

  service.proto:12

  Create a new Service Account. The returned client_id and client_secret can be used as login credentials. Note that the client_secret can only be read out once, at creation.

  message CreateRequest

  service.proto:23

  Request o create a service account.

  • string name = 1

    Name of the service account to create.

  • string initial_group_id = 2

    If set, the service-account will be added to this group upon creation.

  message CreateResponse

  service.proto:31

  Response of creating a service account.

  • optional ServiceAccount service_account = 1

    The created service account.

  • string client_id = 2

    The client id of the service account.

  • string client_secret = 3

    The client secret of the service account.

• rpc List (ListRequest, ListResponse)

  service.proto:15

  List all service accounts.

  message ListRequest

  service.proto:41

  Request to list service accounts.

  (message has no fields)

  message ListResponse

  service.proto:44

  Response for listing service accounts.

  • repeated model.ServiceAccountEntry service_accounts = 1

    the retrieved service accounts.

• rpc Delete (DeleteRequest, DeleteResponse)

  service.proto:19

  Delete a service account. It can take up to the TTL of access tokens for existing sessions using this service_account, to expire.

  message DeleteRequest

  service.proto:50

  Request to delete a service account.

  • string service_account_id = 1

    The id of the service account to delete.

  message DeleteResponse

  service.proto:56

  Empty response for deleting a service account.

  (message has no fields)

Service account model.

Used in: CreateResponse

• string name = 1

  Unique name of the service account.

• optional google.protobuf.Timestamp created_at = 2

  Creation date.

• optional model.Author created_by = 3

  Author of the service account.

• bool managed = 4

  Whether the service account is managed by the system.

• repeated string group_ids = 5

  List of group IDs the service account belongs to.