matrix-js-sdk
    Preparing search index...

    Interface ValidatedAuthMetadata

    Metadata from OAuth 2.0 client authentication API as per https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv1auth_metadata With validated properties required in type

    interface ValidatedAuthMetadata {
        account_management_actions_supported?: string[];
        account_management_uri?: string;
        authorization_endpoint: string;
        code_challenge_methods_supported: string[];
        device_authorization_endpoint?: string;
        grant_types_supported: string[];
        issuer: string;
        prompt_values_supported?: string[];
        registration_endpoint: string;
        response_modes_supported: string[];
        response_types_supported: string[];
        revocation_endpoint: string;
        token_endpoint: string;
    }
    Index
    account_management_actions_supported? account_management_uri? authorization_endpoint code_challenge_methods_supported device_authorization_endpoint? grant_types_supported issuer prompt_values_supported? registration_endpoint response_modes_supported response_types_supported revocation_endpoint token_endpoint
    account_management_actions_supported?: string[]

    List of actions that the account management URL supports.

    account_management_uri?: string

    The URL where the user is able to access the account management capabilities of the homeserver.

    authorization_endpoint: string

    URL of the authorization endpoint, necessary to use the authorization code grant.

    code_challenge_methods_supported: string[]

    List of OAuth 2.0 Proof Key for Code Exchange (PKCE) code challenge methods that the server supports at the authorization endpoint.

    This array MUST contain at least the S256 value, for improved security in the authorization code grant.

    device_authorization_endpoint?: string

    URL of the device authorization endpoint, as defined in RFC 8628, necessary to use the device authorization grant.

    grant_types_supported: string[]

    List of OAuth 2.0 grant type strings that the server supports at the token endpoint.

    This array MUST contain at least the authorization_code and refresh_token values, for clients to be able to use the authorization code grant and refresh token grant, respectively.

    issuer: string

    The authorization server’s issuer identifier, which is a URL that uses the https scheme and has no query or fragment components.

    prompt_values_supported?: string[]

    List of OpenID Connect prompt values that the server supports at the authorization endpoint.

    registration_endpoint: string

    URL of the client registration endpoint, necessary to perform dynamic registration of a client.

    response_modes_supported: string[]

    List of OAuth 2.0 response mode strings that the server supports at the authorization endpoint.

    This array MUST contain at least the query and fragment values, for improved security in the authorization code grant.

    response_types_supported: string[]

    List of OAuth 2.0 response type strings that the server supports at the authorization endpoint.

    This array MUST contain at least the code value, for clients to be able to use the authorization code grant.

    revocation_endpoint: string

    URL of the revocation endpoint, necessary to log out a client by invalidating its access and refresh tokens.

    token_endpoint: string

    URL of the token endpoint, used by the grants.

    Settings
    Member Visibility

    On This Page
    Properties