Interface AuthenticatedEndUser

Represents an Authenticated End-User, created to be used in End-User Applications. This will be created using a token issued by the ax-user-service.

interface AuthenticatedEndUser {
    applicationId: string;
    aud: string;
    email?: string;
    environmentId: string;
    exp: number;
    extensions: unknown;
    iat: number;
    iss: string;
    name: string;
    profileId: string;
    sessionId: string;
    sub: string;
    subjectType: SubjectType;
    tenantId: string;
}

Hierarchy (View Summary)

AuthenticatedEndUserApplication
- AuthenticatedEndUser

Index

Properties

applicationId aud email? environmentId exp extensions iat iss name profileId sessionId sub subjectType tenantId

Properties

applicationId

applicationId: string

The end-user application for this token

Example

f4d491d8-49fc-4bfc-bb69-3c6abd957821

aud

aud: string

Audience of the token

Example

`Optional`email

email?: string

Subject email

Example

john.doe@example.com

environmentId

environmentId: string

Environment ID

exp

exp: number

Expiration time (seconds since Unix epoch)

Example

1641566572

extensions

extensions: unknown

iat

iat: number

Issued at (seconds since Unix epoch)

Example

1638974572

iss

iss: string

Issuer of the token

Example

e.g. ax-id-service or ax-user-service

name

name: string

Subject name

Example

John Doe

profileId

profileId: string

The currently active profile

Example

a208c64a-c487-4554-b726-e4654d2a1c10

sessionId

sessionId: string

The session identifier

Example

f5f2ec54-be1e-4330-9827-13b3e2338551

sub

sub: string

Subject identifier

Example

d68f0268-2703-49ef-9239-7391473fe77a

subjectType

subjectType: SubjectType

Type of the subject

Example

UserAccount

tenantId

tenantId: string

Tenant ID

Interface AuthenticatedEndUser

Hierarchy (View Summary)

Index

Properties

Properties

applicationId

Example

aud

Example

`Optional`email

Example

environmentId

exp

Example

extensions

iat

Example

iss

Example

name

Example

profileId

Example

sessionId

Example

sub

Example

subjectType

Example

tenantId

Settings

On This Page

Interface AuthenticatedEndUser

Hierarchy (View Summary)

Index

Properties

Properties

applicationId

Example

aud

Example

Optionalemail

Example

environmentId

exp

Example

extensions

iat

Example

iss

Example

name

Example

profileId

Example

sessionId

Example

sub

Example

subjectType

Example

tenantId

Settings

On This Page

`Optional`email