Skip to content

Latest commit

 

History

History
184 lines (116 loc) · 3.13 KB

File metadata and controls

184 lines (116 loc) · 3.13 KB
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 5 column 12
---

# UserInfoResponse

The response model from the user info endpoint.

- Full name: `\Logto\Sdk\Oidc\UserInfoResponse`
- Parent class: [`\Logto\Sdk\Models\JsonModel`](../Models/JsonModel.md)

## Properties

### sub

The subject identifier for whom the token is intended (user ID).

```php
public string $sub
```

---

name

The full name of the user.

public ?string $name

username

The username of the user.

public ?string $username

picture

The profile picture URL of the user.

public ?string $picture

email

The email address of the user.

public ?string $email

email_verified

Whether the email address is verified.

public ?bool $email_verified

phone_number

The phone number of the user.

public ?string $phone_number

phone_number_verified

Whether the phone number is verified.

public ?bool $phone_number_verified

roles

The user's roles.

public ?array $roles

organizations

The user's organization IDs.

public ?array $organizations

organization_roles

The user's organization roles.

public ?array $organization_roles

custom_data

The custom data of the user, can be any JSON object.

public mixed $custom_data

identities

The identities of the user, can be a dictionary of key-value pairs, where the key is the identity type and the value is the UserIdentity object.

public ?array $identities

Methods

__construct

public __construct(string $sub, ?string $name = null, ?string $username = null, ?string $picture = null, ?string $email = null, ?bool $email_verified = null, ?string $phone_number = null, ?bool $phone_number_verified = null, ?array $roles = null, ?array $organizations = null, ?array $organization_roles = null, mixed $custom_data = null, ?array $identities = null, mixed $extra): mixed

Parameters:

Parameter Type Description
$sub string
$name ?string
$username ?string
$picture ?string
$email ?string
$email_verified ?bool
$phone_number ?string
$phone_number_verified ?bool
$roles ?array
$organizations ?array
$organization_roles ?array
$custom_data mixed
$identities ?array
$extra mixed

Inherited methods

jsonSerialize

public jsonSerialize(): array


Automatically generated from source code comments using phpDocumentor and saggre/phpdocumentor-markdown