Skip to main content

Class: DefaultApi

Types.DefaultApi

Hierarchy

Constructors

constructor

new DefaultApi(configuration?)

Parameters

NameTypeDefault value
configurationConfigurationDefaultConfig

Inherited from

BaseAPI.constructor

Methods

getChallengeChallengeId

getChallengeChallengeId(requestParameters, initOverrides?): Promise<GetChallengeChallengeId200Response>

Parameters

NameType
requestParametersGetChallengeChallengeIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetChallengeChallengeId200Response>


getChallengeChallengeIdRaw

getChallengeChallengeIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<GetChallengeChallengeId200Response>>

Parameters

NameType
requestParametersGetChallengeChallengeIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetChallengeChallengeId200Response>>


getChallengeChallengeIdV2

getChallengeChallengeIdV2(requestParameters, initOverrides?): Promise<GetChallengeChallengeIdV2200Response>

Parameters

NameType
requestParametersGetChallengeChallengeIdV2Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetChallengeChallengeIdV2200Response>


getChallengeChallengeIdV2Raw

getChallengeChallengeIdV2Raw(requestParameters, initOverrides?): Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>

Parameters

NameType
requestParametersGetChallengeChallengeIdV2Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>


getChallengePackChallengePackId

getChallengePackChallengePackId(requestParameters, initOverrides?): Promise<PostId200Response>

Parameters

NameType
requestParametersGetChallengePackChallengePackIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostId200Response>


getChallengePackChallengePackIdRaw

getChallengePackChallengePackIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostId200Response>>

Parameters

NameType
requestParametersGetChallengePackChallengePackIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostId200Response>>


getMe

getMe(initOverrides?): Promise<GetMe200Response>

Retrieve details of the person and all the organizations they belong to, including: - The organization of the request: the person must be a member of the organization you authenticate with for you to be allowed to retrieve this list - Any other organizations that share the person pool with the organization specified in the request and to which the person also belongs. A hierarchy of organizations can be created using this API endpoint. When organizations are configured to share a person pool, if the same person registers with multiple organizations in the pool using the same handle, all organizations will see the same person ID for that person. Retrieve the person details and list of organizations

Parameters

NameType
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetMe200Response>


getMeOrgs

getMeOrgs(initOverrides?): Promise<GetMeOrgs200Response>

Retrieve all the organizations the person belongs to, including: - The organization of the request: the person must be a member of the organization you authenticate with for you to be allowed to retrieve this list - Any other organizations that share the person pool with the organization specified in the request and to which the person also belongs. A hierarchy of organizations can be created using this API endpoint. When organizations are configured to share a person pool, if the same person registers with multiple organizations in the pool using the same handle, all organizations will see the same person ID for that person. Retrieve the person list of organizations

Parameters

NameType
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetMeOrgs200Response>


getMeOrgsRaw

getMeOrgsRaw(initOverrides?): Promise<ApiResponse<GetMeOrgs200Response>>

Retrieve all the organizations the person belongs to, including: - The organization of the request: the person must be a member of the organization you authenticate with for you to be allowed to retrieve this list - Any other organizations that share the person pool with the organization specified in the request and to which the person also belongs. A hierarchy of organizations can be created using this API endpoint. When organizations are configured to share a person pool, if the same person registers with multiple organizations in the pool using the same handle, all organizations will see the same person ID for that person. Retrieve the person list of organizations

Parameters

NameType
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetMeOrgs200Response>>


getMeRaw

getMeRaw(initOverrides?): Promise<ApiResponse<GetMe200Response>>

Retrieve details of the person and all the organizations they belong to, including: - The organization of the request: the person must be a member of the organization you authenticate with for you to be allowed to retrieve this list - Any other organizations that share the person pool with the organization specified in the request and to which the person also belongs. A hierarchy of organizations can be created using this API endpoint. When organizations are configured to share a person pool, if the same person registers with multiple organizations in the pool using the same handle, all organizations will see the same person ID for that person. Retrieve the person details and list of organizations

Parameters

NameType
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetMe200Response>>


getToken

getToken(requestParameters, initOverrides?): Promise<GetChallengeChallengeIdV2200Response>

Given a token for a Person in an Organization, return a new token for the same user in the Organization specified in the SlashID-OrgID request header. For the call to succeed the following conditions must be met: - the token must be valid at the time of the request - the two Organizations must share the same person pool - the user must be a member of both Organizations This operation does not count as an authentication, so the new token will have the same expiration time as the original. Get a new token for the specified Organization ID

Parameters

NameType
requestParametersGetTokenRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetChallengeChallengeIdV2200Response>


getTokenRaw

getTokenRaw(requestParameters, initOverrides?): Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>

Given a token for a Person in an Organization, return a new token for the same user in the Organization specified in the SlashID-OrgID request header. For the call to succeed the following conditions must be met: - the token must be valid at the time of the request - the two Organizations must share the same person pool - the user must be a member of both Organizations This operation does not count as an authentication, so the new token will have the same expiration time as the original. Get a new token for the specified Organization ID

Parameters

NameType
requestParametersGetTokenRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>


postAttestation

postAttestation(requestParameters, initOverrides?): Promise<GetChallengeChallengeId200Response>

Parameters

NameType
requestParametersPostAttestationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetChallengeChallengeId200Response>


postAttestationRaw

postAttestationRaw(requestParameters, initOverrides?): Promise<ApiResponse<GetChallengeChallengeId200Response>>

Parameters

NameType
requestParametersPostAttestationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetChallengeChallengeId200Response>>


postAttestationV2

postAttestationV2(requestParameters, initOverrides?): Promise<GetChallengeChallengeIdV2200Response>

Parameters

NameType
requestParametersPostAttestationV2Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<GetChallengeChallengeIdV2200Response>


postAttestationV2Raw

postAttestationV2Raw(requestParameters, initOverrides?): Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>

Parameters

NameType
requestParametersPostAttestationV2Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<GetChallengeChallengeIdV2200Response>>


postAttestationV3

postAttestationV3(requestParameters, initOverrides?): Promise<PostAttestationV3200Response>

Parameters

NameType
requestParametersPostAttestationV3Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostAttestationV3200Response>


postAttestationV3Raw

postAttestationV3Raw(requestParameters, initOverrides?): Promise<ApiResponse<PostAttestationV3200Response>>

Parameters

NameType
requestParametersPostAttestationV3Request
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostAttestationV3200Response>>


postDirectId

postDirectId(requestParameters?, initOverrides?): Promise<PostDirectId201Response>

Parameters

NameType
requestParametersPostDirectIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostDirectId201Response>


postDirectIdRaw

postDirectIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostDirectId201Response>>

Parameters

NameType
requestParametersPostDirectIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostDirectId201Response>>


postId

postId(requestParameters, initOverrides?): Promise<PostId200Response>

Parameters

NameType
requestParametersPostIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostId200Response>


postIdRaw

postIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostId200Response>>

Parameters

NameType
requestParametersPostIdRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostId200Response>>


postRecover

postRecover(requestParameters, initOverrides?): Promise<PostId200Response>

Parameters

NameType
requestParametersPostRecoverRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostId200Response>


postRecoverRaw

postRecoverRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostId200Response>>

Parameters

NameType
requestParametersPostRecoverRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostId200Response>>


postSsoResolve

postSsoResolve(requestParameters, initOverrides?): Promise<void>

Resolve endpoint for SSO flows using PKCE. SSO resolve challenge endpoint

Parameters

NameType
requestParametersPostSsoResolveOperationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<void>


postSsoResolveRaw

postSsoResolveRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Resolve endpoint for SSO flows using PKCE. SSO resolve challenge endpoint

Parameters

NameType
requestParametersPostSsoResolveOperationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...postMiddlewares(undefined | (context: ResponseContext) => Promise<void | Response>)[]

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...preMiddlewares(undefined | (context: RequestContext) => Promise<void | FetchParams>)[]

Returns

T

Inherited from

BaseAPI.withPreMiddleware