@asgardeo/javascript 0.7.1 → 0.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AsgardeoJavaScriptClient.d.ts +3 -4
- package/dist/IsomorphicCrypto.d.ts +2 -2
- package/dist/StorageManager.d.ts +6 -8
- package/dist/__legacy__/client.d.ts +15 -15
- package/dist/__legacy__/helpers/authentication-helper.d.ts +5 -5
- package/dist/__legacy__/models/client-config.d.ts +14 -14
- package/dist/api/createOrganization.d.ts +8 -8
- package/dist/api/getAllOrganizations.d.ts +5 -5
- package/dist/api/getBrandingPreference.d.ts +5 -5
- package/dist/api/getMeOrganizations.d.ts +9 -9
- package/dist/api/getOrganization.d.ts +4 -4
- package/dist/api/getSchemas.d.ts +4 -4
- package/dist/api/getScim2Me.d.ts +4 -4
- package/dist/api/updateMeProfile.d.ts +7 -7
- package/dist/api/updateOrganization.d.ts +5 -5
- package/dist/api/v2/executeEmbeddedUserOnboardingFlowV2.d.ts +16 -16
- package/dist/cjs/index.js +1183 -1186
- package/dist/cjs/index.js.map +4 -4
- package/dist/constants/ApplicationNativeAuthenticationConstants.d.ts +14 -14
- package/dist/constants/OIDCDiscoveryConstants.d.ts +17 -106
- package/dist/constants/OIDCRequestConstants.d.ts +6 -44
- package/dist/constants/PKCEConstants.d.ts +3 -18
- package/dist/constants/TokenConstants.d.ts +2 -31
- package/dist/constants/TokenExchangeConstants.d.ts +5 -30
- package/dist/index.js +1184 -1187
- package/dist/index.js.map +4 -4
- package/dist/models/branding-preference.d.ts +5 -5
- package/dist/models/client.d.ts +57 -58
- package/dist/models/config.d.ts +48 -48
- package/dist/models/crypto.d.ts +11 -11
- package/dist/models/embedded-flow.d.ts +10 -10
- package/dist/models/field.d.ts +8 -8
- package/dist/models/oidc-discovery.d.ts +161 -161
- package/dist/models/oidc-endpoints.d.ts +15 -15
- package/dist/models/platforms.d.ts +2 -2
- package/dist/models/scim2-schema.d.ts +17 -17
- package/dist/models/session.d.ts +4 -4
- package/dist/models/store.d.ts +9 -9
- package/dist/models/user.d.ts +5 -5
- package/dist/models/v2/embedded-flow-v2.d.ts +86 -86
- package/dist/models/v2/embedded-signin-flow-v2.d.ts +39 -39
- package/dist/models/v2/embedded-signup-flow-v2.d.ts +42 -42
- package/dist/theme/types.d.ts +133 -133
- package/dist/utils/getAuthorizeRequestUrlParams.d.ts +4 -3
- package/dist/utils/logger.d.ts +6 -6
- package/dist/utils/processUsername.d.ts +1 -1
- package/package.json +1 -1
- package/dist/utils/cryptoUtils.d.ts +0 -0
|
@@ -15,14 +15,13 @@
|
|
|
15
15
|
* specific language governing permissions and limitations
|
|
16
16
|
* under the License.
|
|
17
17
|
*/
|
|
18
|
-
import { AllOrganizationsApiResponse } from './models/organization';
|
|
19
18
|
import { AsgardeoClient } from './models/client';
|
|
20
19
|
import { Config, SignInOptions, SignOutOptions, SignUpOptions } from './models/config';
|
|
21
|
-
import { Storage } from './models/store';
|
|
22
20
|
import { EmbeddedFlowExecuteRequestPayload, EmbeddedFlowExecuteResponse } from './models/embedded-flow';
|
|
23
21
|
import { EmbeddedSignInFlowHandleRequestPayload } from './models/embedded-signin-flow';
|
|
22
|
+
import { AllOrganizationsApiResponse, Organization } from './models/organization';
|
|
23
|
+
import { Storage } from './models/store';
|
|
24
24
|
import { TokenExchangeRequestConfig, TokenResponse } from './models/token';
|
|
25
|
-
import { Organization } from './models/organization';
|
|
26
25
|
import { User, UserProfile } from './models/user';
|
|
27
26
|
/**
|
|
28
27
|
* Base class for implementing Asgardeo clients.
|
|
@@ -55,6 +54,6 @@ declare abstract class AsgardeoJavaScriptClient<T = Config> implements AsgardeoC
|
|
|
55
54
|
abstract getAccessToken(sessionId?: string): Promise<string>;
|
|
56
55
|
abstract clearSession(sessionId?: string): void;
|
|
57
56
|
abstract setSession(sessionData: Record<string, unknown>, sessionId?: string): Promise<void>;
|
|
58
|
-
abstract decodeJwtToken<
|
|
57
|
+
abstract decodeJwtToken<R = Record<string, unknown>>(token: string): Promise<R>;
|
|
59
58
|
}
|
|
60
59
|
export default AsgardeoJavaScriptClient;
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
*/
|
|
18
18
|
import { Crypto, JWKInterface } from './models/crypto';
|
|
19
19
|
export declare class IsomorphicCrypto<T = any> {
|
|
20
|
-
private
|
|
20
|
+
private cryptoUtils;
|
|
21
21
|
constructor(cryptoUtils: Crypto<T>);
|
|
22
22
|
/**
|
|
23
23
|
* Generate code verifier.
|
|
@@ -59,5 +59,5 @@ export declare class IsomorphicCrypto<T = any> {
|
|
|
59
59
|
* @throws
|
|
60
60
|
*/
|
|
61
61
|
isValidIdToken(idToken: string, jwk: JWKInterface, clientId: string, issuer: string, username: string, clockTolerance: number | undefined, validateJwtIssuer: boolean | undefined): Promise<boolean>;
|
|
62
|
-
decodeJwtToken<
|
|
62
|
+
decodeJwtToken<R = Record<string, unknown>>(token: string): R;
|
|
63
63
|
}
|
package/dist/StorageManager.d.ts
CHANGED
|
@@ -15,23 +15,21 @@
|
|
|
15
15
|
* specific language governing permissions and limitations
|
|
16
16
|
* under the License.
|
|
17
17
|
*/
|
|
18
|
-
import { Stores } from './models/store';
|
|
19
|
-
import { Storage } from './models/store';
|
|
20
18
|
import { AuthClientConfig } from './__legacy__/models';
|
|
21
|
-
import { SessionData } from './models/session';
|
|
22
|
-
import { TemporaryStore, TemporaryStoreValue } from './models/store';
|
|
23
19
|
import { OIDCDiscoveryApiResponse } from './models/oidc-discovery';
|
|
20
|
+
import { SessionData } from './models/session';
|
|
21
|
+
import { Stores, Storage, TemporaryStore, TemporaryStoreValue } from './models/store';
|
|
24
22
|
type PartialData<T> = Partial<AuthClientConfig<T> | OIDCDiscoveryApiResponse | SessionData | TemporaryStore>;
|
|
25
23
|
export declare const ASGARDEO_SESSION_ACTIVE: string;
|
|
26
24
|
declare class StorageManager<T> {
|
|
27
|
-
protected
|
|
28
|
-
protected
|
|
25
|
+
protected id: string;
|
|
26
|
+
protected store: Storage;
|
|
29
27
|
constructor(instanceID: string, store: Storage);
|
|
30
28
|
protected setDataInBulk(key: string, data: PartialData<T>): Promise<void>;
|
|
31
29
|
protected setValue(key: string, attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore, value: TemporaryStoreValue): Promise<void>;
|
|
32
30
|
protected removeValue(key: string, attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore): Promise<void>;
|
|
33
|
-
protected
|
|
34
|
-
protected isLocalStorageAvailable(): boolean;
|
|
31
|
+
protected resolveKey(store: Stores | string, userId?: string): string;
|
|
32
|
+
protected static isLocalStorageAvailable(): boolean;
|
|
35
33
|
setConfigData(config: Partial<AuthClientConfig<T>>): Promise<void>;
|
|
36
34
|
setOIDCProviderMetaData(oidcProviderMetaData: Partial<OIDCDiscoveryApiResponse>): Promise<void>;
|
|
37
35
|
setTemporaryData(temporaryData: Partial<TemporaryStore>, userId?: string): Promise<void>;
|
|
@@ -15,28 +15,28 @@
|
|
|
15
15
|
* specific language governing permissions and limitations
|
|
16
16
|
* under the License.
|
|
17
17
|
*/
|
|
18
|
-
import StorageManager from '../StorageManager';
|
|
19
18
|
import { AuthClientConfig } from './models';
|
|
20
|
-
import {
|
|
19
|
+
import { IsomorphicCrypto } from '../IsomorphicCrypto';
|
|
21
20
|
import { Crypto } from '../models/crypto';
|
|
22
|
-
import {
|
|
21
|
+
import { ExtendedAuthorizeRequestUrlParams } from '../models/oauth-request';
|
|
23
22
|
import { OIDCEndpoints } from '../models/oidc-endpoints';
|
|
24
|
-
import { Storage } from '../models/store';
|
|
25
|
-
import { IsomorphicCrypto } from '../IsomorphicCrypto';
|
|
26
23
|
import { UserSession } from '../models/session';
|
|
24
|
+
import { Storage } from '../models/store';
|
|
25
|
+
import { TokenResponse, IdToken, TokenExchangeRequestConfig } from '../models/token';
|
|
27
26
|
import { User } from '../models/user';
|
|
27
|
+
import StorageManager from '../StorageManager';
|
|
28
28
|
/**
|
|
29
29
|
* This class provides the necessary methods needed to implement authentication.
|
|
30
30
|
*/
|
|
31
31
|
export declare class AsgardeoAuthClient<T> {
|
|
32
|
-
private
|
|
33
|
-
private
|
|
34
|
-
private
|
|
35
|
-
private
|
|
36
|
-
private
|
|
37
|
-
private
|
|
38
|
-
private
|
|
39
|
-
static
|
|
32
|
+
private storageManager;
|
|
33
|
+
private configProvider;
|
|
34
|
+
private oidcProviderMetaDataProvider;
|
|
35
|
+
private authHelper;
|
|
36
|
+
private cryptoUtils;
|
|
37
|
+
private cryptoHelper;
|
|
38
|
+
private instanceIdValue;
|
|
39
|
+
static authHelperInstance: any;
|
|
40
40
|
/**
|
|
41
41
|
* This is the constructor method that returns an instance of the .
|
|
42
42
|
*
|
|
@@ -72,7 +72,7 @@ export declare class AsgardeoAuthClient<T> {
|
|
|
72
72
|
*
|
|
73
73
|
* @preserve
|
|
74
74
|
*/
|
|
75
|
-
initialize(config: AuthClientConfig<T>, store: Storage,
|
|
75
|
+
initialize(config: AuthClientConfig<T>, store: Storage, inputCryptoUtils: Crypto, instanceID?: number): Promise<void>;
|
|
76
76
|
/**
|
|
77
77
|
* This method returns the `StorageManager` object that allows you to access authentication data.
|
|
78
78
|
*
|
|
@@ -200,7 +200,7 @@ export declare class AsgardeoAuthClient<T> {
|
|
|
200
200
|
* const decodedToken = await auth.decodeJwtToken(token);
|
|
201
201
|
* ```
|
|
202
202
|
*/
|
|
203
|
-
decodeJwtToken<
|
|
203
|
+
decodeJwtToken<U = Record<string, unknown>>(token: string): Promise<U>;
|
|
204
204
|
/**
|
|
205
205
|
* This method decodes the payload of the ID token and returns it.
|
|
206
206
|
*
|
|
@@ -21,11 +21,11 @@ import { TokenResponse } from '../../models/token';
|
|
|
21
21
|
import { User } from '../../models/user';
|
|
22
22
|
import StorageManager from '../../StorageManager';
|
|
23
23
|
export declare class AuthenticationHelper<T> {
|
|
24
|
-
private
|
|
25
|
-
private
|
|
26
|
-
private
|
|
27
|
-
private
|
|
28
|
-
constructor(
|
|
24
|
+
private storageManager;
|
|
25
|
+
private config;
|
|
26
|
+
private oidcProviderMetaData;
|
|
27
|
+
private cryptoHelper;
|
|
28
|
+
constructor(storageManagerInstance: StorageManager<T>, cryptoHelperInstance: IsomorphicCrypto);
|
|
29
29
|
resolveEndpoints(response: OIDCDiscoveryApiResponse): Promise<OIDCDiscoveryApiResponse>;
|
|
30
30
|
resolveEndpointsExplicitly(): Promise<OIDCDiscoveryEndpointsApiResponse>;
|
|
31
31
|
resolveEndpointsByBaseURL(): Promise<OIDCDiscoveryEndpointsApiResponse>;
|
|
@@ -27,11 +27,22 @@ export interface DefaultAuthClientConfig {
|
|
|
27
27
|
prompt?: string;
|
|
28
28
|
responseMode?: OAuthResponseMode;
|
|
29
29
|
scopes?: string | string[] | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* Specifies if cookies should be sent with access-token requests, refresh-token requests,
|
|
32
|
+
* custom-grant requests, etc.
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
sendCookiesInRequests?: boolean;
|
|
36
|
+
sendIdTokenInLogoutRequest?: boolean;
|
|
30
37
|
tokenValidation?: {
|
|
31
38
|
/**
|
|
32
39
|
* ID token validation config.
|
|
33
40
|
*/
|
|
34
41
|
idToken?: {
|
|
42
|
+
/**
|
|
43
|
+
* Allowed leeway for ID tokens (in seconds).
|
|
44
|
+
*/
|
|
45
|
+
clockTolerance?: number;
|
|
35
46
|
/**
|
|
36
47
|
* Whether to validate ID tokens.
|
|
37
48
|
*/
|
|
@@ -40,24 +51,13 @@ export interface DefaultAuthClientConfig {
|
|
|
40
51
|
* Whether to validate the issuer of ID tokens.
|
|
41
52
|
*/
|
|
42
53
|
validateIssuer?: boolean;
|
|
43
|
-
/**
|
|
44
|
-
* Allowed leeway for ID tokens (in seconds).
|
|
45
|
-
*/
|
|
46
|
-
clockTolerance?: number;
|
|
47
54
|
};
|
|
48
55
|
};
|
|
49
|
-
/**
|
|
50
|
-
* Specifies if cookies should be sent with access-token requests, refresh-token requests,
|
|
51
|
-
* custom-grant requests, etc.
|
|
52
|
-
*
|
|
53
|
-
*/
|
|
54
|
-
sendCookiesInRequests?: boolean;
|
|
55
|
-
sendIdTokenInLogoutRequest?: boolean;
|
|
56
56
|
}
|
|
57
57
|
export interface WellKnownAuthClientConfig extends DefaultAuthClientConfig {
|
|
58
|
-
wellKnownEndpoint: string;
|
|
59
|
-
endpoints?: Partial<OIDCEndpoints>;
|
|
60
58
|
baseUrl?: string;
|
|
59
|
+
endpoints?: Partial<OIDCEndpoints>;
|
|
60
|
+
wellKnownEndpoint: string;
|
|
61
61
|
}
|
|
62
62
|
export interface BaseURLAuthClientConfig extends DefaultAuthClientConfig {
|
|
63
63
|
baseUrl: string;
|
|
@@ -65,8 +65,8 @@ export interface BaseURLAuthClientConfig extends DefaultAuthClientConfig {
|
|
|
65
65
|
wellKnownEndpoint?: string;
|
|
66
66
|
}
|
|
67
67
|
export interface ExplicitAuthClientConfig extends DefaultAuthClientConfig {
|
|
68
|
-
endpoints: OIDCEndpoints;
|
|
69
68
|
baseUrl?: string;
|
|
69
|
+
endpoints: OIDCEndpoints;
|
|
70
70
|
wellKnownEndpoint?: string;
|
|
71
71
|
}
|
|
72
72
|
export type StrictAuthClientConfig = WellKnownAuthClientConfig | BaseURLAuthClientConfig | ExplicitAuthClientConfig;
|
|
@@ -24,14 +24,14 @@ export interface CreateOrganizationPayload {
|
|
|
24
24
|
* Organization description.
|
|
25
25
|
*/
|
|
26
26
|
description: string;
|
|
27
|
-
/**
|
|
28
|
-
* Organization handle/slug.
|
|
29
|
-
*/
|
|
30
|
-
orgHandle?: string;
|
|
31
27
|
/**
|
|
32
28
|
* Organization name.
|
|
33
29
|
*/
|
|
34
30
|
name: string;
|
|
31
|
+
/**
|
|
32
|
+
* Organization handle/slug.
|
|
33
|
+
*/
|
|
34
|
+
orgHandle?: string;
|
|
35
35
|
/**
|
|
36
36
|
* Parent organization ID.
|
|
37
37
|
*/
|
|
@@ -49,15 +49,15 @@ export interface CreateOrganizationConfig extends Omit<RequestInit, 'method' | '
|
|
|
49
49
|
* The base URL for the API endpoint.
|
|
50
50
|
*/
|
|
51
51
|
baseUrl: string;
|
|
52
|
-
/**
|
|
53
|
-
* Organization creation payload
|
|
54
|
-
*/
|
|
55
|
-
payload: CreateOrganizationPayload;
|
|
56
52
|
/**
|
|
57
53
|
* Optional custom fetcher function.
|
|
58
54
|
* If not provided, native fetch will be used
|
|
59
55
|
*/
|
|
60
56
|
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
57
|
+
/**
|
|
58
|
+
* Organization creation payload
|
|
59
|
+
*/
|
|
60
|
+
payload: CreateOrganizationPayload;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
63
|
* Creates a new organization.
|
|
@@ -24,6 +24,11 @@ export interface GetAllOrganizationsConfig extends Omit<RequestInit, 'method'> {
|
|
|
24
24
|
* The base URL for the API endpoint.
|
|
25
25
|
*/
|
|
26
26
|
baseUrl: string;
|
|
27
|
+
/**
|
|
28
|
+
* Optional custom fetcher function.
|
|
29
|
+
* If not provided, native fetch will be used
|
|
30
|
+
*/
|
|
31
|
+
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
27
32
|
/**
|
|
28
33
|
* Filter expression for organizations
|
|
29
34
|
*/
|
|
@@ -36,11 +41,6 @@ export interface GetAllOrganizationsConfig extends Omit<RequestInit, 'method'> {
|
|
|
36
41
|
* Whether to include child organizations recursively
|
|
37
42
|
*/
|
|
38
43
|
recursive?: boolean;
|
|
39
|
-
/**
|
|
40
|
-
* Optional custom fetcher function.
|
|
41
|
-
* If not provided, native fetch will be used
|
|
42
|
-
*/
|
|
43
|
-
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
46
|
* Retrieves all organizations with pagination support.
|
|
@@ -24,6 +24,11 @@ export interface GetBrandingPreferenceConfig extends Omit<RequestInit, 'method'>
|
|
|
24
24
|
* The base URL for the API endpoint.
|
|
25
25
|
*/
|
|
26
26
|
baseUrl: string;
|
|
27
|
+
/**
|
|
28
|
+
* Optional custom fetcher function.
|
|
29
|
+
* If not provided, native fetch will be used
|
|
30
|
+
*/
|
|
31
|
+
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
27
32
|
/**
|
|
28
33
|
* Locale for the branding preference
|
|
29
34
|
*/
|
|
@@ -36,11 +41,6 @@ export interface GetBrandingPreferenceConfig extends Omit<RequestInit, 'method'>
|
|
|
36
41
|
* Type of the branding preference
|
|
37
42
|
*/
|
|
38
43
|
type?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Optional custom fetcher function.
|
|
41
|
-
* If not provided, native fetch will be used
|
|
42
|
-
*/
|
|
43
|
-
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
46
|
* Retrieves branding preference configuration.
|
|
@@ -20,10 +20,6 @@ import { Organization } from '../models/organization';
|
|
|
20
20
|
* Configuration for the getMeOrganizations request
|
|
21
21
|
*/
|
|
22
22
|
export interface GetMeOrganizationsConfig extends Omit<RequestInit, 'method'> {
|
|
23
|
-
/**
|
|
24
|
-
* The base URL for the API endpoint.
|
|
25
|
-
*/
|
|
26
|
-
baseUrl: string;
|
|
27
23
|
/**
|
|
28
24
|
* Base64 encoded cursor value for forward pagination
|
|
29
25
|
*/
|
|
@@ -32,10 +28,19 @@ export interface GetMeOrganizationsConfig extends Omit<RequestInit, 'method'> {
|
|
|
32
28
|
* Authorized application name filter
|
|
33
29
|
*/
|
|
34
30
|
authorizedAppName?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The base URL for the API endpoint.
|
|
33
|
+
*/
|
|
34
|
+
baseUrl: string;
|
|
35
35
|
/**
|
|
36
36
|
* Base64 encoded cursor value for backward pagination
|
|
37
37
|
*/
|
|
38
38
|
before?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Optional custom fetcher function.
|
|
41
|
+
* If not provided, native fetch will be used
|
|
42
|
+
*/
|
|
43
|
+
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
39
44
|
/**
|
|
40
45
|
* Filter expression for organizations
|
|
41
46
|
*/
|
|
@@ -48,11 +53,6 @@ export interface GetMeOrganizationsConfig extends Omit<RequestInit, 'method'> {
|
|
|
48
53
|
* Whether to include child organizations recursively
|
|
49
54
|
*/
|
|
50
55
|
recursive?: boolean;
|
|
51
|
-
/**
|
|
52
|
-
* Optional custom fetcher function.
|
|
53
|
-
* If not provided, native fetch will be used
|
|
54
|
-
*/
|
|
55
|
-
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
58
|
* Retrieves the organizations associated with the current user.
|
|
@@ -42,15 +42,15 @@ export interface GetOrganizationConfig extends Omit<RequestInit, 'method'> {
|
|
|
42
42
|
* The base URL for the API endpoint.
|
|
43
43
|
*/
|
|
44
44
|
baseUrl: string;
|
|
45
|
-
/**
|
|
46
|
-
* The ID of the organization to retrieve
|
|
47
|
-
*/
|
|
48
|
-
organizationId: string;
|
|
49
45
|
/**
|
|
50
46
|
* Optional custom fetcher function.
|
|
51
47
|
* If not provided, native fetch will be used
|
|
52
48
|
*/
|
|
53
49
|
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
50
|
+
/**
|
|
51
|
+
* The ID of the organization to retrieve
|
|
52
|
+
*/
|
|
53
|
+
organizationId: string;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
56
|
* Retrieves detailed information for a specific organization.
|
package/dist/api/getSchemas.d.ts
CHANGED
|
@@ -20,10 +20,6 @@ import { Schema } from '../models/scim2-schema';
|
|
|
20
20
|
* Configuration for the getSchemas request
|
|
21
21
|
*/
|
|
22
22
|
export interface GetSchemasConfig extends Omit<RequestInit, 'method'> {
|
|
23
|
-
/**
|
|
24
|
-
* The absolute API endpoint.
|
|
25
|
-
*/
|
|
26
|
-
url?: string;
|
|
27
23
|
/**
|
|
28
24
|
* The base path of the API endpoint.
|
|
29
25
|
*/
|
|
@@ -33,6 +29,10 @@ export interface GetSchemasConfig extends Omit<RequestInit, 'method'> {
|
|
|
33
29
|
* If not provided, native fetch will be used
|
|
34
30
|
*/
|
|
35
31
|
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
32
|
+
/**
|
|
33
|
+
* The absolute API endpoint.
|
|
34
|
+
*/
|
|
35
|
+
url?: string;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
38
|
* Retrieves the SCIM2 schemas from the specified endpoint.
|
package/dist/api/getScim2Me.d.ts
CHANGED
|
@@ -20,10 +20,6 @@ import { User } from '../models/user';
|
|
|
20
20
|
* Configuration for the getScim2Me request
|
|
21
21
|
*/
|
|
22
22
|
export interface GetScim2MeConfig extends Omit<RequestInit, 'method'> {
|
|
23
|
-
/**
|
|
24
|
-
* The absolute API endpoint.
|
|
25
|
-
*/
|
|
26
|
-
url?: string;
|
|
27
23
|
/**
|
|
28
24
|
* The base path of the API endpoint.
|
|
29
25
|
*/
|
|
@@ -33,6 +29,10 @@ export interface GetScim2MeConfig extends Omit<RequestInit, 'method'> {
|
|
|
33
29
|
* If not provided, native fetch will be used
|
|
34
30
|
*/
|
|
35
31
|
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
32
|
+
/**
|
|
33
|
+
* The absolute API endpoint.
|
|
34
|
+
*/
|
|
35
|
+
url?: string;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
38
|
* Retrieves the user profile information from the specified SCIM2 /Me endpoint.
|
|
@@ -20,23 +20,23 @@ import { User } from '../models/user';
|
|
|
20
20
|
* Configuration for the updateMeProfile request
|
|
21
21
|
*/
|
|
22
22
|
export interface UpdateMeProfileConfig extends Omit<RequestInit, 'method' | 'body'> {
|
|
23
|
-
/**
|
|
24
|
-
* The absolute API endpoint.
|
|
25
|
-
*/
|
|
26
|
-
url?: string;
|
|
27
23
|
/**
|
|
28
24
|
* The base path of the API endpoint.
|
|
29
25
|
*/
|
|
30
26
|
baseUrl?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Optional custom fetcher function.
|
|
29
|
+
* If not provided, native fetch will be used
|
|
30
|
+
*/
|
|
31
|
+
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
31
32
|
/**
|
|
32
33
|
* The value object to patch (SCIM2 PATCH value)
|
|
33
34
|
*/
|
|
34
35
|
payload: any;
|
|
35
36
|
/**
|
|
36
|
-
*
|
|
37
|
-
* If not provided, native fetch will be used
|
|
37
|
+
* The absolute API endpoint.
|
|
38
38
|
*/
|
|
39
|
-
|
|
39
|
+
url?: string;
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
42
|
* Updates the user profile information at the specified SCIM2 Me endpoint.
|
|
@@ -25,9 +25,10 @@ export interface UpdateOrganizationConfig extends Omit<RequestInit, 'method' | '
|
|
|
25
25
|
*/
|
|
26
26
|
baseUrl: string;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Optional custom fetcher function.
|
|
29
|
+
* If not provided, native fetch will be used
|
|
29
30
|
*/
|
|
30
|
-
|
|
31
|
+
fetcher?: (url: string, config: RequestInit) => Promise<Response>;
|
|
31
32
|
/**
|
|
32
33
|
* Array of patch operations to apply
|
|
33
34
|
*/
|
|
@@ -37,10 +38,9 @@ export interface UpdateOrganizationConfig extends Omit<RequestInit, 'method' | '
|
|
|
37
38
|
value?: any;
|
|
38
39
|
}>;
|
|
39
40
|
/**
|
|
40
|
-
*
|
|
41
|
-
* If not provided, native fetch will be used
|
|
41
|
+
* The ID of the organization to update
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
organizationId: string;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
46
|
* Updates the organization information using the Organizations Management API.
|
|
@@ -20,35 +20,35 @@ import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2
|
|
|
20
20
|
* Response from the user onboarding flow execution.
|
|
21
21
|
*/
|
|
22
22
|
export interface EmbeddedUserOnboardingFlowResponse {
|
|
23
|
-
/**
|
|
24
|
-
* Unique identifier for the flow execution.
|
|
25
|
-
*/
|
|
26
|
-
flowId: string;
|
|
27
|
-
/**
|
|
28
|
-
* Current status of the flow.
|
|
29
|
-
*/
|
|
30
|
-
flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
|
|
31
|
-
/**
|
|
32
|
-
* Type of the current step in the flow.
|
|
33
|
-
*/
|
|
34
|
-
type?: 'VIEW' | 'REDIRECTION';
|
|
35
23
|
/**
|
|
36
24
|
* Data for the current step including components and additional data.
|
|
37
25
|
*/
|
|
38
26
|
data?: {
|
|
39
|
-
/**
|
|
40
|
-
* UI components to render for the current step.
|
|
41
|
-
*/
|
|
42
|
-
components?: any[];
|
|
43
27
|
/**
|
|
44
28
|
* Additional data from the flow step (e.g., inviteLink).
|
|
45
29
|
*/
|
|
46
30
|
additionalData?: Record<string, string>;
|
|
31
|
+
/**
|
|
32
|
+
* UI components to render for the current step.
|
|
33
|
+
*/
|
|
34
|
+
components?: any[];
|
|
47
35
|
};
|
|
48
36
|
/**
|
|
49
37
|
* Reason for failure if flowStatus is ERROR.
|
|
50
38
|
*/
|
|
51
39
|
failureReason?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Unique identifier for the flow execution.
|
|
42
|
+
*/
|
|
43
|
+
flowId: string;
|
|
44
|
+
/**
|
|
45
|
+
* Current status of the flow.
|
|
46
|
+
*/
|
|
47
|
+
flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
|
|
48
|
+
/**
|
|
49
|
+
* Type of the current step in the flow.
|
|
50
|
+
*/
|
|
51
|
+
type?: 'VIEW' | 'REDIRECTION';
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
54
|
* Executes an embedded user onboarding flow by sending a request to the flow execution endpoint.
|