Type Alias RestCredentials

RestCredentials: {
    appId?: string;
    appSecret?: string;
    password?: string;
    refreshToken?: string;
    scope?: string;
    token?: string;
    type?: CredentialType;
    username?: string;
}

Credentials needed to access Domino REST API server. Required properties changes depending on type. If type is basic then username and password is needed, otherwise, if type is oauth, then application ID, application secret and refresh token is required.

Type declaration

  • OptionalappId?: string

    Required for oauth credentials. The application ID.

  • OptionalappSecret?: string

    Required for oauth credentials. The application secret.

  • Optionalpassword?: string

    Required for basic credentials. The password of user.

  • OptionalrefreshToken?: string

    Required for oauth credentials. The refresh token.

  • Optionalscope?: string

    The scope/s you want access to separated by spaces.

  • Optionaltoken?: string

    Required for token credentials. Access token for Domino REST API.

  • Optionaltype?: CredentialType

    The type of credentials given. Can be 'basic' or 'oauth'. Defaults to 'basic' if not given.

  • Optionalusername?: string

    Required for basic credentials. The username of user.

Settings

Member Visibility