@webitel/api-services
    Preparing search index...

    Interface WebitelImApiGatewayV1TokenRequest

    interface WebitelImApiGatewayV1TokenRequest {
        clientId?: string;
        clientSecret?: string;
        code?: string;
        identity?: WebitelImApiGatewayV1Identity;
        refreshToken?: string;
        scope?: string[];
        state?: string;
    }
    Index

    Properties

    clientId? clientSecret? code? identity? refreshToken? scope? state?

    Properties

    clientId?: string

    The client identifier issued to the client during the registration process. REQUIRED, if the client is not authenticating with the authorization server. May be transmitted in header: [X-Webitel-Client].

    clientSecret?: string

    REQUIRED. The client secret. The client MAY omit the parameter if the client secret is an empty string.

    Including the client credentials in the request-body using the two parameters is NOT RECOMMENDED and SHOULD be limited to clients unable to directly utilize the HTTP Basic authentication scheme (or other password-based HTTP authentication schemes). The parameters can only be transmitted in the request-body and MUST NOT be included in the request URI.

    Keep it a secret.

    code?: string

    Authorization code grant. REQUIRED. When grant_type is set to "authorization_code".

    identity?: WebitelImApiGatewayV1Identity

    Identity of the end-User account association. REQUIRED. When grant_type is set to "identity".

    refreshToken?: string

    Refresh token string to obtain NEW access token. REQUIRED. When grant_type is set to "refresh_token".

    scope?: string[]
    state?: string

    Settings

    Member Visibility

    On This Page

    Properties