Credential QML Type

  • Esri.ArcGISRuntime
  • Credential
  • A credential used for accessing secured ArcGIS services and portals. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0





    • bool equals(Credential credential)

    Detailed Description

    A credential is composed of user account information (username and password), OAuth client information (OAuthClientInfo), or a secured token.

    HTTP basic and digest authentication is supported.

    Client certificate authentication is also supported for certificate secured resources. Provide an instance of Pkcs12Info to the credential to configure it for certificate-based authentication.

    This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

    See also OAuthClientInfo and Pkcs12Info.

    Property Documentation

    [read-only] authenticatingHost : url

    Returns the host (including port number) that a username/password will be sent to for authentication (read-only).

    [read-only] authenticationType : Enums.AuthenticationType

    Returns the authentication type that was used for the credential (read-only).

    This is the authentication type requested by a secure service.

    See also Enums.AuthenticationType.

    oAuthAuthorizationCode : string

    The OAuth authorization code used for generating a user access token.

    [default] oAuthClientInfo : OAuthClientInfo

    The OAuth client information used for OAuth authentication to identify a registered application.

    [since Esri.ArcGISRuntime 100.1] oAuthRefreshToken : string

    The OAuth refresh token used for generating a new user access token after the old one expires.

    This property was introduced in Esri.ArcGISRuntime 100.1.

    password : string

    The password for the credential.

    [default] pkcs12Info : Pkcs12Info

    The PKCS#12 information file containing certificates required to access a secured resource.

    When PKCS#12 info is provided to this property, an attempt is made to open the provided certificate file to extract a single private key, its certificate and any associated CA certificates from the file. If successful, the SSL configuration will include these details for any network request that consumes this credential.

    See also Pkcs12Info.

    referer : string

    A string representing the referer for which the long-lived token was generated.

    [read-only] sslRequired : bool

    Returns whether the token provider requires that this token should only be transmitted over HTTPS (read-only).

    token : string

    The token used to access a secured service.

    The server that is running a secured service generates the token using a username/password combination.

    tokenExpiry : time

    The expiration date for the token credential.

    tokenServiceUrl : url

    The remote token service's URL.

    username : string

    The username for the credential.

    Signal Documentation


    Emitted when the oAuthAuthorizationCode property changes.

    Note: The corresponding handler is onOAuthAuthorizationCodeChanged.


    Emitted when the oAuthClientInfo property changes.

    Note: The corresponding handler is onOAuthClientInfoChanged.

    [since Esri.ArcGISRuntime 100.1] oAuthRefreshTokenChanged()

    Emitted when the oAuthRefreshToken property changes.

    Note: The corresponding handler is onOAuthRefreshTokenChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    Emitted when the password property changes.

    Note: The corresponding handler is onPasswordChanged.


    Emitted when the pkcs12Info property changes.

    Note: The corresponding handler is onPkcs12InfoChanged.


    Emitted when the referer property changes.

    Note: The corresponding handler is onRefererChanged.


    Emitted when the token property changes.

    Note: The corresponding handler is onTokenChanged.


    Emitted when the tokenExpiry property changes.

    Note: The corresponding handler is onTokenExpiryChanged.


    Emitted when the tokenServiceUrl property changes.

    Note: The corresponding handler is onTokenServiceUrlChanged.


    Emitted when the username property changes.

    Note: The corresponding handler is onUsernameChanged.

    Method Documentation

    bool equals(Credential credential)

    Returns true if this Credential object is equal to the provided credential.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.