List all user profiles

List all user profiles in the current project. This operation supports pagination by cursor. The results are ordered alphabetically by name.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
identityType
string (IdentityTypeFilter)

The identity type filter field indicates the type of principal the request should be filtered to show. If no value is specified, the default value is USER.

  • ALL: All types of principals.
  • USER: Human user.
  • SERVICE_PRINCIPAL: Service account.
  • INTERNAL_SERVICE: Internal CDF service.
Enum: "ALL" "USER" "SERVICE_PRINCIPAL" "INTERNAL_SERVICE"
limit
integer [ 1 .. 1000 ]
Default: 25

Limits the number of results to be returned. The server returns no more than 1000 results even if the specified limit is larger. The default limit is 25.

cursor
string

Cursor for paging through results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200
get/profiles
Request samples 
const response = await client.profiles.list({ limit: 1000 });
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Retrieve one or more user profiles by ID