google-auth-library documentation
  1. Miscellaneous
  2. Variables

Index

src/index.ts

auth
Default value : new GoogleAuth()

src/auth/awsrequestsigner.ts

AWS_ALGORITHM
Type : string
Default value : 'AWS4-HMAC-SHA256'

AWS Signature Version 4 signing algorithm identifier.
AWS_REQUEST_TYPE
Type : string
Default value : 'aws4_request'

The termination string for the AWS credential scope value as defined in https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html

src/auth/baseexternalclient.ts

CLOUD_RESOURCE_MANAGER
Type : string
Default value : 'https://cloudresourcemanager.googleapis.com/v1/projects/'

Cloud resource manager URL used to retrieve project information.
DEFAULT_OAUTH_SCOPE
Type : string
Default value : 'https://www.googleapis.com/auth/cloud-platform'

The default OAuth scope to request when none is provided.
EXPIRATION_TIME_OFFSET
Default value : 5 * 60 * 1000

Offset to take into account network delays and server clock skews.
EXTERNAL_ACCOUNT_TYPE
Type : string
Default value : 'external_account'

The credentials JSON file type for external account clients. There are 3 types of JSON configs:

  1. authorized_user => Google end user credential
  2. service_account => Google service account credential
  3. external_Account => non-GCP service (eg. AWS, Azure, K8s)
GOOGLE_APIS_DOMAIN_PATTERN
Type : string
Default value : '\\.googleapis\\.com$'

The google apis domain pattern.
STS_GRANT_TYPE
Type : string
Default value : 'urn:ietf:params:oauth:grant-type:token-exchange'

The required token exchange grant_type: rfc8693#section-2.1
STS_REQUEST_TOKEN_TYPE
Type : string
Default value : 'urn:ietf:params:oauth:token-type:access_token'

The requested token exchange requested_token_type: rfc8693#section-2.1
VARIABLE_PORTION_PATTERN
Type : string
Default value : '[^\\.\\s\\/\\\\]+'

The variable portion pattern in a Google APIs domain.
WORKFORCE_AUDIENCE_PATTERN
Type : string
Default value : '//iam.googleapis.com/locations/[^/]+/workforcePools/[^/]+/providers/.+'

The workforce audience pattern.

src/auth/googleauth.ts

CLOUD_SDK_CLIENT_ID
Type : string
Default value : '764086051850-6qr4p6gpi6hn506pt8ejuq83di341hur.apps.googleusercontent.com'

src/auth/jwtaccess.ts

DEFAULT_HEADER
Type : jws.Header
Default value : { alg: 'RS256', typ: 'JWT', }

src/auth/envDetect.ts

envPromise
Type : Promise | undefined

src/auth/downscopedclient.ts

EXPIRATION_TIME_OFFSET
Default value : 5 * 60 * 1000

Offset to take into account network delays and server clock skews.
MAX_ACCESS_BOUNDARY_RULES_COUNT
Type : number
Default value : 10

The maximum number of access boundary rules a Credential Access Boundary can contain.
STS_ACCESS_TOKEN_URL
Type : string
Default value : 'https://sts.googleapis.com/v1/token'

The STS access token exchange end point.
STS_GRANT_TYPE
Type : string
Default value : 'urn:ietf:params:oauth:grant-type:token-exchange'

The required token exchange grant_type: rfc8693#section-2.1
STS_REQUEST_TOKEN_TYPE
Type : string
Default value : 'urn:ietf:params:oauth:token-type:access_token'

The requested token exchange requested_token_type: rfc8693#section-2.1
STS_SUBJECT_TOKEN_TYPE
Type : string
Default value : 'urn:ietf:params:oauth:token-type:access_token'

The requested token exchange subject_token_type: rfc8693#section-2.1

src/auth/identitypoolclient.ts

lstat
Default value : promisify(fs.lstat ?? (() => {}))
readFile
Default value : promisify(fs.readFile ?? (() => {}))
realpath
Default value : promisify(fs.realpath ?? (() => {}))

src/auth/oauth2common.ts

METHODS_SUPPORTING_REQUEST_BODY
Type : []
Default value : ['PUT', 'POST', 'PATCH']

List of HTTP methods that accept request bodies.

src/transporters.ts

pkg
Default value : require('../../package.json')
PRODUCT_NAME
Type : string
Default value : 'google-api-nodejs-client'

results matching ""

    No results matching ""