Skip to content

Latest commit

 

History

History
166 lines (97 loc) · 4.54 KB

API.md

File metadata and controls

166 lines (97 loc) · 4.54 KB
Raw

API Reference

Constructs

OidcMockApi

Creates a mock OIDC Identity Provider.

Initializers 

import { OidcMockApi } from '@wheatstalk/oidc-mock'

new OidcMockApi(scope: Construct, id: string)
Name Type Description
scope constructs.Construct No description.
id string No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { OidcMockApi } from '@wheatstalk/oidc-mock'

OidcMockApi.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
authUrl string The URL for the auth endpoint.
jwksUrl string The URL for the jwks endpoint.
openidConfigurationUrl string The full URL to access the openid-configuration endpoint.
restApi aws-cdk-lib.aws_apigateway.RestApi The REST API.
tokenUrl string The URL for the token endpoint.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

authUrlRequired 
public readonly authUrl: string;
  • Type: string

The URL for the auth endpoint.

jwksUrlRequired 
public readonly jwksUrl: string;
  • Type: string

The URL for the jwks endpoint.

openidConfigurationUrlRequired 
public readonly openidConfigurationUrl: string;
  • Type: string

The full URL to access the openid-configuration endpoint.

restApiRequired 
public readonly restApi: RestApi;
  • Type: aws-cdk-lib.aws_apigateway.RestApi

The REST API.

tokenUrlRequired 
public readonly tokenUrl: string;
  • Type: string

The URL for the token endpoint.