API reference (20230101-alpha)
- Overview
- Overview
- GET(deprecated) Get the user profile of the principal issuing the requestdeprecated
- GETGet the user profile of the principal issuing the requestdeprecated
- GETList all user profiles in the current projectdeprecated
- POSTRetrieve profiles by ID in the current projectdeprecated
- POSTSearch user profiles in the current projectdeprecated
const response = await client.profiles.list({ limit: 1000 });{
"items": [
{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}
],
"nextCursor": "<string>"
}List all user profiles in the current project
Required capabilities:
userProfilesAcl:READ
Deprecated in favor of the List principals endpoint.
List all user profiles in the current project. This operation supports pagination by cursor. The results are ordered alphabetically by name.
const response = await client.profiles.list({ limit: 1000 });{
"items": [
{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}
],
"nextCursor": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Query Parameters
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.
ALL, USER, SERVICE_PRINCIPAL, INTERNAL_SERVICE 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.
1 <= x <= 1000Cursor for paging through results. In general, if a response contains a nextCursor
property, it means that there may be more results, and you should pass that value as the
cursor parameter in the next request.
Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Was this page helpful?