Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface ClientCredentials

    Optional. Used for OAuth2 authentication.

    interface ClientCredentials {
        client_id: string;
        client_secret: string;
        endpoint: string;
        response_type?: string;
        scope?: string;
        token_request_type?: string;
    }
    Index

    Properties

    client_id client_secret endpoint response_type? scope? token_request_type?

    Properties

    client_id: string

    The Client ID that will be used in the OAuth2 Client Credentials flow.

    client_secret: string

    The Client Secret that will be used in the OAuth2 Client Credentials flow.

    endpoint: string

    The endpoint that will be used in the OAuth2 Client Credentials flow. Expected to return a JSON with an access token and expires_in value (in seconds). The expires_in value, which must be a minimum of 30 seconds and a maximum of 3600 seconds, is how long Sinch will save the access token before asking for a new one.

    response_type?: string

    Optional. When granting client_credentials, this is generally omitted. If you do provide a value, it will be forwarded to your OAuth provider as-is. Max length: 64 characters.

    scope?: string

    Optional. Space-separated string per RFC 6749. Used to limit the access granted by the token. Max length: 1024 characters. If blank or omitted, this is not included in the token request.

    token_request_type?: string

    Optional. Controls how client_id and client_secret are sent to the token endpoint. Either BASIC or FORM. If not set or unrecognized, BASIC is used by default.

    Settings

    Member Visibility

    On This Page

    Properties