Sign in
Service Accounts (iam/v2)

Create a Service Account

General Availability

Make a request to create a service account.

post/iam/v2/service-accounts

Query parameters

assigned_resource_ownerstring

Filter a collection by a string search

The resource_id of the principal who will be assigned resource owner on the created service account. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx).

Request body

api_version'iam/v2'

APIVersion defines the schema version of this representation of a resource.

kind'ServiceAccount'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

A human-readable name for the Service Account

descriptionstring

A free-form description of the Service Account

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/service-accounts/sa-12345",
    "resource_name": "crn://confluent.cloud/service-account=sa-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "DeLorean_auto_repair",
  "description": "Doc's repair bot for the DeLorean"
}

Response

A Service Account was created.

api_version'iam/v2'

APIVersion defines the schema version of this representation of a resource.

kind'ServiceAccount'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

A human-readable name for the Service Account

descriptionstring

A free-form description of the Service Account

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/service-accounts/sa-12345",
    "resource_name": "crn://confluent.cloud/service-account=sa-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "DeLorean_auto_repair",
  "description": "Doc's repair bot for the DeLorean"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.