Interface HostedExtractorSourceClientCredentialsAuthenticationCreate

interface HostedExtractorSourceClientCredentialsAuthenticationCreate {
    audience?: string;
    clientId: string;
    clientSecret: string;
    defaultExpiresIn?: number;
    resource?: string;
    scopes?: string;
    tokenUrl: string;
    type: "clientCredentials";
}

Hierarchy (view full)

Properties

audience?: string

Audience passed as part of the token request. Some identity providers reject token requests without it, unless a default audience is configured.

clientId: string

Client ID of the service principal used by the extractor.

clientSecret: string

Client secret of the service principal used by the extractor.

defaultExpiresIn?: number

Default value for the OAuth 2.0 expires_in parameter. Required if the identity provider does not return expires_in.

resource?: string

Resource passed as part of the token request.

scopes?: string

A space separated list of scopes.

tokenUrl: string

URL to fetch authentication tokens from.

type: "clientCredentials"