API reference (20230101-beta)
- 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.me();{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}(deprecated) Get the user profile of the principal issuing the request
Required capabilities:
userProfilesAcl:READ
Deprecated in favor of the new endpoint.
Retrieves the user profile of the principal issuing the request. If a principal doesn’t have a user profile, you get a not found (404) response code. Note: User profiles are created asyncronously, so the endpoint might return 404 for a new principal for a while (usually seconds) until the profile has been created.
const response = await client.profiles.me();{
"userIdentifier": "abcd",
"lastUpdatedTime": 1730204346000,
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"jobTitle": "Software Engineer",
"identityType": "USER"
}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.
Response
Uniquely identifies the principal the profile is associated with. This property is guaranteed to be immutable.
"abcd"
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The user's first name.
"Jane"
The user's last name.
"Doe"
The user's email address (if any). The email address is is returned directly from
the identity provider and not guaranteed to be verified.
Note that the email is mutable and can be updated in the identity provider. It should
not be used to uniquely identify as a user. Use the userIdentifier property instead.
"jane.doe@example.com"
The display name for the user.
"Jane Doe"
The user's job title.
"Software Engineer"
The identity type field indicates the type of principal.
USER: Human user.SERVICE_PRINCIPAL: Service account.INTERNAL_SERVICE: Internal CDF service.
USER, SERVICE_PRINCIPAL, INTERNAL_SERVICE Was this page helpful?