Access - List Service Accounts

Service:

Confluent

API Version:

2024-07-01

Organization service accounts details

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listServiceAccounts?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
organizationName	path	True	string	Organization resource name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
searchFilters	object	Search filters for the request

Responses

Name	Type	Description
200 OK	AccessListServiceAccountsSuccessResponse	Azure operation completed successfully.
Other Status Codes	ResourceProviderDefaultErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Access_ServiceAccountsList

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/access/default/listServiceAccounts?api-version=2024-07-01

{
  "searchFilters": {
    "pageSize": "10",
    "pageToken": "asc4fts4ft"
  }
}

Sample response

Status code:

200

{
  "data": [
    {
      "description": "Doc's repair bot for the DeLorean",
      "display_name": "DeLorean_auto_repair",
      "id": "dlz-f3a90de",
      "kind": "ServiceAccount",
      "metadata": {
        "created_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00",
        "resource_name": "crn://confluent.cloud/service-account=sa-12345",
        "self": "https://api.confluent.cloud/iam/v2/service-accounts/sa-12345",
        "updated_at": "2006-01-02T15:04:05-07:00"
      }
    }
  ],
  "kind": "ServiceAccountList",
  "metadata": {
    "first": "https://api.confluent.cloud/iam/v2/service-accounts",
    "last": "https://api.confluent.cloud/iam/v2/service-accounts?page_token=bcAOehAY8F16YD84Z1wT",
    "next": "https://api.confluent.cloud/iam/v2/service-accounts?page_token=UvmDWOB1iwfAIBPj6EYb",
    "prev": "https://api.confluent.cloud/iam/v2/service-accounts?page_token=YIXRY97wWYmwzrax4dld",
    "total_size": 123
  }
}

Definitions

Name	Description
AccessListServiceAccountsSuccessResponse	List service accounts success response
ConfluentListMetadata	Metadata of the list
ErrorResponseBody	Response body of Error
ListAccessRequestModel	List Access Request Model
MetadataEntity	Metadata of the data record
ResourceProviderDefaultErrorResponse	Default error response for resource provider
ServiceAccountRecord	Record of the service account

AccessListServiceAccountsSuccessResponse

Object

List service accounts success response

Name	Type	Description
data	ServiceAccountRecord[]	Data of the service accounts list
kind	string	Type of response
metadata	ConfluentListMetadata	Metadata of the list

ConfluentListMetadata

Object

Metadata of the list

Name	Type	Description
first	string	First page of the list
last	string	Last page of the list
next	string	Next page of the list
prev	string	Previous page of the list
total_size	integer (int32)	Total size of the list

ErrorResponseBody

Object

Response body of Error

Name	Type	Description
code	string	Error code
details	ErrorResponseBody[]	Error detail
message	string	Error message
target	string	Error target

ListAccessRequestModel

Object

List Access Request Model

Name	Type	Description
searchFilters	object	Search filters for the request

MetadataEntity

Object

Metadata of the data record

Name	Type	Description
created_at	string	Created Date Time
deleted_at	string	Deleted Date time
resource_name	string	Resource name of the record
self	string	Self lookup url
updated_at	string	Updated Date time

ResourceProviderDefaultErrorResponse

Object

Default error response for resource provider

Name	Type	Description
error	ErrorResponseBody	Response body of Error

ServiceAccountRecord

Object

Record of the service account

Name	Type	Description
description	string	Description of the service account
display_name	string	Name of the service account
id	string	Id of the service account
kind	string	Type of account
metadata	MetadataEntity	Metadata of the record