Type alias AuthorizeResponse

AuthorizeResponse: {
    accountId?: string;
    claims?: string;
    client_info?: string;
    cloud_graph_host_name?: string;
    cloud_instance_host_name?: string;
    cloud_instance_name?: string;
    code?: string;
    correlation_id?: string;
    ear_jwe?: string;
    error?: string;
    error_description?: string;
    error_uri?: string;
    msgraph_host?: string;
    state?: string;
    suberror?: string;
    timestamp?: string;
    trace_id?: string;
}

Response properties that may be returned by the /authorize endpoint

Type declaration

  • Optional accountId?: string

    AccountId for the user, returned when platform broker is available to use

  • Optional claims?: string

    Claims

  • Optional client_info?: string

    Client info object containing UserId and TenantId

  • Optional cloud_graph_host_name?: string

    AAD Graph hostname returned when application is instance aware https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-graph-api

  • Optional cloud_instance_host_name?: string

    Cloud instance hostname returned when application is instance aware

  • Optional cloud_instance_name?: string

    Cloud instance returned when application is instance aware

  • Optional code?: string

    Authorization Code to be exchanged for tokens

  • Optional correlation_id?: string

    Correlation ID use to look up request in logs

  • Optional ear_jwe?: string

    Encrypted Authorize Response (EAR) JWE

  • Optional error?: string

    Server error code

  • Optional error_description?: string

    Server error description

  • Optional error_uri?: string

    Server error URI

  • Optional msgraph_host?: string

    Microsoft Graph hostname returned when application is instance aware https://docs.microsoft.com/en-us/graph/overview

  • Optional state?: string

    State string, should match what was sent on request

  • Optional suberror?: string

    Server Sub-Error

  • Optional timestamp?: string

    Timestamp of request

  • Optional trace_id?: string

    Trace Id used to look up request in logs

Generated using TypeDoc