Table of Contents

Class UserSummary

Namespace
Vonage.Users.GetUsers
Assembly
Vonage.dll

Represents a lightweight summary of a user, containing basic identification information without full channel details.

public record UserSummary : IEquatable<UserSummary>
Inheritance
UserSummary
Implements
Inherited Members

Constructors

Represents a lightweight summary of a user, containing basic identification information without full channel details.

public UserSummary(string Id, string Name, string DisplayName, HalLinks Links)

Parameters

Id string

The unique identifier for the user (e.g., "USR-12345678-1234-1234-1234-123456789012").

Name string

The unique name assigned to the user within the Vonage platform.

DisplayName string

A human-readable display name for the user. Unlike the Name, this does not need to be unique.

Links HalLinks

HAL links for navigating to the full user resource.

Properties

DisplayName

A human-readable display name for the user. Unlike the Name, this does not need to be unique.

[JsonPropertyName("display_name")]
[JsonPropertyOrder(2)]
public string DisplayName { get; init; }

Property Value

string

Id

The unique identifier for the user (e.g., "USR-12345678-1234-1234-1234-123456789012").

[JsonPropertyOrder(0)]
public string Id { get; init; }

Property Value

string

HAL links for navigating to the full user resource.

[JsonPropertyName("_links")]
[JsonPropertyOrder(3)]
public HalLinks Links { get; init; }

Property Value

HalLinks

Name

The unique name assigned to the user within the Vonage platform.

[JsonPropertyName("name")]
[JsonPropertyOrder(1)]
public string Name { get; init; }

Property Value

string