IGUHealth
    Preparing search index...

    Interface AccessTokenPayload<role>

    interface AccessTokenPayload<role> {
        aud: string;
        encounter?: id;
        exp?: number;
        fhirContext?: Reference[];
        fhirUser?: canonical;
        "https://iguhealth.app/accessPolicyVersionIds": id[];
        "https://iguhealth.app/resourceId": id;
        "https://iguhealth.app/resourceType": TOKEN_RESOURCE_TYPES;
        "https://iguhealth.app/role": role;
        "https://iguhealth.app/tenant": TenantId;
        iat?: number;
        iss: Issuer;
        jti?: string;
        nbf?: number;
        patient?: id;
        scope: string;
        sub: Subject;
        [propName: string]: unknown;
    }

    Type Parameters

    • role

    Hierarchy (View Summary)

    Indexable

    • [propName: string]: unknown

      Any other JWT Claim Set member.

    Index

    Properties

    aud: string

    REQUIRED. Audience(s) that this ID Token is intended for. It MUST contain the OAuth 2.0 client_id of the Relying Party as an audience value. It MAY also contain identifiers for other audiences. In the general case, the aud value is an array of case-sensitive strings. In the common special case when there is one audience, the aud value MAY be a single case-sensitive string.

    encounter?: id
    exp?: number

    JWT Expiration Time

    fhirContext?: Reference[]
    fhirUser?: canonical
    "https://iguhealth.app/accessPolicyVersionIds": id[]
    "https://iguhealth.app/resourceId": id

    The ID of the resource the token is associated with.

    "https://iguhealth.app/resourceType": TOKEN_RESOURCE_TYPES

    Token can be associated with an Operation, Client or Membership this claim distinguishes between the three.

    "https://iguhealth.app/role": role

    The users role for the tenant.

    "https://iguhealth.app/tenant": TenantId

    The tenant the token is associated with.

    iat?: number

    JWT Issued At

    iss: Issuer

    REQUIRED. Issuer Identifier for the Issuer of the response. The iss value is a case-sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components.

    jti?: string

    JWT ID

    nbf?: number

    JWT Not Before

    patient?: id
    scope: string

    scope Required. OAuth 2.0 scopes. Space-separated string.

    sub: Subject

    sub REQUIRED. Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4. It MUST NOT exceed 255 ASCII [RFC20] characters in length. The sub value is a case-sensitive string.