IGUHealth
    Preparing search index...

    Interface ClientApplication

    interface ClientApplication {
        _description?: Element;
        _grantType?: Element[];
        _logoUri?: Element;
        _name?: Element;
        _policyUri?: Element;
        _redirectUri?: Element[];
        _responseTypes?: Element;
        _scope?: Element;
        _secret?: Element;
        _tosUri?: Element;
        _uri?: Element;
        contact?: ContactPoint;
        description?: string;
        grantType: code[];
        id?: id;
        logoUri?: uri;
        meta?: Meta;
        name: string;
        policyUri?: uri;
        redirectUri?: string[];
        resourceType: "ClientApplication";
        responseTypes: code;
        scope?: string;
        secret?: string;
        tosUri?: uri;
        uri?: uri;
    }
    Index

    Properties

    _description? _grantType? _logoUri? _name? _policyUri? _redirectUri? _responseTypes? _scope? _secret? _tosUri? _uri? contact? description? grantType id? logoUri? meta? name policyUri? redirectUri? resourceType responseTypes scope? secret? tosUri? uri?

    Properties

    Optional_description

    _description?: Element

    The description of the client to be presented to the end-user.

    Optional_grantType

    _grantType?: Element[]

    Auth 2.0 grant type strings that the client can use at the token endpoint.

    Optional_logoUri

    _logoUri?: Element

    URL string that references a logo for the client.

    Optional_name

    _name?: Element

    The name of the client to be presented to the end-user.

    Optional_policyUri

    _policyUri?: Element

    URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

    Optional_redirectUri

    _redirectUri?: Element[]

    Array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows. As required by Section 2 of OAuth 2.0 [RFC6749], clients using flows with redirection MUST register their redirection URI values. Authorization servers that support dynamic registration for redirect-based flows MUST implement support for this metadata value.

    Optional_responseTypes

    _responseTypes?: Element

    OAuth 2.0 response type strings that the client can use at the authorization endpoint.

    Optional_scope

    _scope?: Element

    String containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.

    Optional_secret

    _secret?: Element

    This value is used by confidential clients to authenticate to the token endpoint, as described in OAuth 2.0 [RFC6749], Section 2.3.1.

    Optional_tosUri

    _tosUri?: Element

    URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

    Optional_uri

    _uri?: Element

    URL string of a web page providing information about the client.

    contact?: ContactPoint

    Array of strings representing ways to contact people responsible for this client, typically email addresses.

    description?: string

    The description of the client to be presented to the end-user.

    grantType: code[]

    Auth 2.0 grant type strings that the client can use at the token endpoint.

    id?: id

    Logical id of this artifact

    logoUri?: uri

    URL string that references a logo for the client.

    meta?: Meta

    Metadata about the resource

    name: string

    The name of the client to be presented to the end-user.

    policyUri?: uri

    URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

    redirectUri?: string[]

    Array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows. As required by Section 2 of OAuth 2.0 [RFC6749], clients using flows with redirection MUST register their redirection URI values. Authorization servers that support dynamic registration for redirect-based flows MUST implement support for this metadata value.

    resourceType: "ClientApplication"
    responseTypes: code

    OAuth 2.0 response type strings that the client can use at the authorization endpoint.

    scope?: string

    String containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.

    secret?: string

    This value is used by confidential clients to authenticate to the token endpoint, as described in OAuth 2.0 [RFC6749], Section 2.3.1.

    tosUri?: uri

    URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

    uri?: uri

    URL string of a web page providing information about the client.

    Settings

    Member Visibility

    On This Page

    Properties