NOTE: Searches external client grants for all users

Search returns external client grants for all users in the tenant.

POST /api/v1/search/iam/external_clients

Search

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.ExternalClientSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.ExternalClientSearchServiceSearchResponse != nil {
        // handle response
    }
}

200

{
  "list": [
    {
      "clientId": "<string>",
      "clientIdType": "CLIENT_ID_TYPE_UNSPECIFIED",
      "clientIdUrl": "<string>",
      "clientName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "displayName": "<string>",
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "mcpClientId": "<string>",
      "roleIds": [
        "<string>"
      ],
      "userId": "<string>",
      "verifiedDomain": "<string>",
      "wellKnownClient": "WELL_KNOWN_CLIENT_UNSPECIFIED"
    }
  ],
  "nextPageToken": "<string>"
}

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 ExternalClientSearchServiceSearchRequest message.

clientIdUrls · string[] | null

Exact-match filter on client_id values (e.g., CIMD URLs). Returns only grants whose client_id matches one of these values.

pageSize · integer<int32>

The pageSize field.

pageToken · string

The pageToken field.

query · string

Free-text search on client_name and user display name

users · User Ref · object[] | null

Filter by specific user IDs

Show child attributes

wellKnownClients · enum<string>[] | null

Filter by well-known client type (e.g., CLAUDE_CODE, CURSOR, etc.)

Available options: WELL_KNOWN_CLIENT_UNSPECIFIED, WELL_KNOWN_CLIENT_UNKNOWN, WELL_KNOWN_CLIENT_CLAUDE_AI, WELL_KNOWN_CLIENT_CLAUDE_DESKTOP, WELL_KNOWN_CLIENT_CLAUDE_CODE, WELL_KNOWN_CLIENT_MCP_INSPECTOR, WELL_KNOWN_CLIENT_CHATGPT, WELL_KNOWN_CLIENT_VSCODE, WELL_KNOWN_CLIENT_CURSOR, WELL_KNOWN_CLIENT_WINDSURF, WELL_KNOWN_CLIENT_ZED, WELL_KNOWN_CLIENT_JETBRAINS, WELL_KNOWN_CLIENT_DOCKER_MCP_TOOLKIT

Response

200 - application/json

Successful response

The ExternalClientSearchServiceSearchResponse message.

list · External Client Info · object[] | null

Uses ExternalClientInfo with user_id populated for admin views

Show child attributes

nextPageToken · string

The nextPageToken field.