oauth-helper-temp

The following environment variables are used:

| Env variable name | Description | Default | Comments | | ----------------- | ----------- | ------- | -------- | | OAUTH_HELPER_TEMP_SOURCE | swagger source: swaggerhub or bitbucket | swaggerhub | | | OAUTH_HELPER_TEMP_ACCOUNT | swagger account to use for accessing API on swaggerhub | mimik | swaggerhub only | | OAUTH_HELPER_TEMP_API_KEY | API key for the private API on swaggerhub | | swaggerhub only | | OAUTH_HELPER_TEMP_BITBUCKET_KEY_PATH | path to key.json with bitbucket credentials | | bitbucket only | | OAUTH_HELPER_TEMP_BITBUCKET_WORKSPACE | bitbucket workspace | mimiktech | bitbucket only | | OAUTH_HELPER_TEMP_BITBUCKET_API_URL | bitbucket API base URL | https://api.bitbucket.org/2.0/repositories | bitbucket only |

The config should contain the customerCode if needed. If the customerCode is not available in the config, a default uuid will be used.

When OAUTH_HELPER_TEMP_SOURCE is set to bitbucket, swagger definitions are fetched from Bitbucket repositories instead of SwaggerHub. The key.json file must contain { "bitbucket": { "username": "...", "password": "..." } }. The latest version is determined from the repository's semver tags.

Example

import oauthHelper from '@mimik/oauth-helper-temp';

• oauth-helper-temp
  • static
    • .getAdminTokens(mSTAdminToken, mSTBaseUrl, customerName, environment, targets, correlationId) ⇒ Promise
    • .getSystemTokens(mSTAdminToken, mSTBaseUrl, customerName, typePairs, correlationId) ⇒ Promise
  • inner
    • ~rpAuth(type, options) ⇒ Promise
    • ~createUserToken(type, userId, appId, correlationId) ⇒ Promise
    • ~createUserTokenAll(types, userId, appId, correlationId) ⇒ Promise
    • ~createUserTokenWithOnBehalf(type, userId, appId, onBehalfId, correlationId) ⇒ Promise
    • ~createUserTokenAllWithOnBehalf(types, userId, appId, onBehalfId, correlationId) ⇒ Promise
    • ~createAdminToken(type, customerCode, correlationId) ⇒ Promise
    • ~createSystemToken(type, customerCode, correlationId) ⇒ Promise

oauth-helper-temp.getAdminTokens(mSTAdminToken, mSTBaseUrl, customerName, environment, targets, correlationId) ⇒ Promise

Get admin tokens.

Kind: static method of oauth-helper-temp
Returns: Promise - .
Category: async
Fulfil: object An array of responses with tokens.

config is ignored for that function.

| Param | Type | Description | | --- | --- | --- | | mSTAdminToken | string | Token to access admin operation of mST. | | mSTBaseUrl | URL.<string> | BaseUrl to use to access mST endpoints. | | customerName | string | Name of the customer for which the token will be provided. | | environment | string | Environment used to define the admin tokens. | | targets | array | Array of { type } to get the admin tokens. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the tokens. |

oauth-helper-temp.getSystemTokens(mSTAdminToken, mSTBaseUrl, customerName, typePairs, correlationId) ⇒ Promise

Get system tokens.

Kind: static method of oauth-helper-temp
Returns: Promise - .
Category: async
Fulfil: object An array of responses with tokens.

config is ignored for that function.

| Param | Type | Description | | --- | --- | --- | | mSTAdminToken | string | Token to access admin operation of mST. | | mSTBaseUrl | URL.<string> | BaseUrl to use to access mST endpoints. | | customerName | string | Name of the customer for which the token will be provided. | | typePairs | object | Array of pair of { origType, destType } to get the system tokens. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the tokens. |

oauth-helper-temp~rpAuth(type, options) ⇒ Promise

Make an authorized request.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error as rpauth in oauth-helper.

Fulfil: object - Response from the authorized request.

| Param | Type | Description | | --- | --- | --- | | type | string | Type of micro service to request. | | options | object | Options for the request. Similar to rpauth in oauth-helper options. |

oauth-helper-temp~createUserToken(type, userId, appId, correlationId) ⇒ Promise

Create a user token.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The user token.

| Param | Type | Description | | --- | --- | --- | | type | string | Type of micro-service to request. | | userId | string | User id to assign to the token. | | appId | string | Application id to associate with the request. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |

oauth-helper-temp~createUserTokenAll(types, userId, appId, correlationId) ⇒ Promise

Create a user token with many services.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The user token.

| Param | Type | Description | | --- | --- | --- | | types | Array.<string> | Array of type of micro-service to request. | | userId | string | User id to assign to the token. | | appId | string | Application id to associate with the request. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |

oauth-helper-temp~createUserTokenWithOnBehalf(type, userId, appId, onBehalfId, correlationId) ⇒ Promise

Create an onBehalfId token.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The onBehalf token.

| Param | Type | Description | | --- | --- | --- | | type | string | Type of micro-service to request. | | userId | string | User id to assign to the token. | | appId | string | Application id to associate with the request. | | onBehalfId | string | User id to assign to the token to act on behalf. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |

oauth-helper-temp~createUserTokenAllWithOnBehalf(types, userId, appId, onBehalfId, correlationId) ⇒ Promise

Create an onBehalfId token with many services.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The onBehalf token.

| Param | Type | Description | | --- | --- | --- | | types | Array.<string> | Array of type of micro-service to request. | | userId | string | User id to assign to the token. | | appId | string | Application id to associate with the request. | | onBehalfId | string | User id to assign to the token to act on behalf. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |

oauth-helper-temp~createAdminToken(type, customerCode, correlationId) ⇒ Promise

Create an admin token.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The admin token.

| Param | Type | Description | | --- | --- | --- | | type | string | Type of micro-service to request. | | customerCode | UUID.<string> | customer code to be added in the token. If not present, config.serverSettings.customerCode or randomUUID() will be used. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |

oauth-helper-temp~createSystemToken(type, customerCode, correlationId) ⇒ Promise

Create a system token.

Kind: inner method of oauth-helper-temp
Returns: Promise - .
Category: async
Throws:

• Promise Will throw the same error if the token cannot be created.

Fulfil: JWT<object> The system token.

| Param | Type | Description | | --- | --- | --- | | type | string | Type of micro-service to request. | | customerCode | UUID.<string> | customer code to be added in the token. If not present, config.serverSettings.customerCode or randomUUID() will be used. | | correlationId | UUID.<string> | CorrelationId associated with the creation of the token. |