Get the user profile of the principal issuing the request

{ "userIdentifier": "-cFNuYkHgnn5q8pnlVlCRg", "displayName": "Jane Doe", "pictureUrl": "https://auth.cognite.com/api/v1/orgs/cog-cognite/principals/HByt5JcYe1jYgnN5kFSGikthqcFHJjg4kxciGBFUWbBFv4unyt/picture?_n=1730959200&_e=1731067200&_k=EdCqRojhpCzDNF6JrrpfZgp", "identityType": "USER", "lastUpdatedTime": 1730204346000, "givenName": "Jane", "surname": "Doe", "email": "jane.doe@example.com" }

Response

200 - application/json

Principal's profile data

Option 1
Option 2

userIdentifier

string

required

Uniquely identifies the principal the profile is associated with.

Example:

"-cFNuYkHgnn5q8pnlVlCRg"

displayName

string

required

The display name for the user.

Example:

"Jane Doe"

pictureUrl

string<url>

required

The avatar of the service account

Example:

"https://auth.cognite.com/api/v1/orgs/cog-cognite/principals/HByt5JcYe1jYgnN5kFSGikthqcFHJjg4kxciGBFUWbBFv4unyt/picture?_n=1730959200&_e=1731067200&_k=EdCqRojhpCzDNF6JrrpfZgp"

identityType

enum<string>

required

Available options:

USER

lastUpdatedTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

givenName

string

The user's first name.

Example:

"Jane"

surname

string

The user's last name.

Example:

"Doe"

string

The user's email address (if any). The email address is is returned directly from the identity provider and not guaranteed to be verified. It should not be used to uniquely identify as a user. Use the userIdentifier property instead.

Example:

"jane.doe@example.com"

API reference (20230101-beta)

Response