@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
40 lines (39 loc) • 1.33 kB
TypeScript
/**
* Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { Schema } from '@asgardeo/browser';
/**
* Retrieves the SCIM2 schemas from the specified endpoint.
*
* @param requestConfig - Request configuration object.
* @returns A promise that resolves with the SCIM2 schemas information.
* @example
* ```typescript
* try {
* const schemas = await getSchemas({
* url: "https://api.asgardeo.io/t/<ORGANIZATION>/scim2/Schemas",
* });
* console.log(schemas);
* } catch (error) {
* if (error instanceof AsgardeoAPIError) {
* console.error('Failed to get schemas:', error.message);
* }
* }
* ```
*/
declare const getSchemas: ({ url }: Partial<Request>) => Promise<Schema[]>;
export default getSchemas;