Skip to main content
POST
NOTE: Searches personal and service principal API keys

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The APIKeySearchServiceSearchRequest message.

pageSize
integer<int32>

The maximum number of results to return per page.

pageToken
string

A pagination token returned from a previous Search call.

query
string

A text query to filter API keys by display name.

types
enum<string>[] | null

The key types to return. When empty, both types are returned.

Available options:
API_KEY_TYPE_UNSPECIFIED,
API_KEY_TYPE_PERSONAL,
API_KEY_TYPE_SERVICE_PRINCIPAL

Response

200 - application/json

Successful response

The APIKeySearchServiceSearchResponse message.

list
Api Key · object[] | null

The list of API keys matching the search criteria.

nextPageToken
string

A token to retrieve the next page of results, or empty if there are no more results.