@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
39 lines (38 loc) • 1.41 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 { User } from '@asgardeo/browser';
/**
* Updates the user profile information at the specified SCIM2 Me endpoint.
*
* @param url - The SCIM2 Me endpoint URL.
* @param value - The value object to patch (SCIM2 PATCH value).
* @param requestConfig - Additional request config if needed.
* @returns A promise that resolves with the updated user profile information.
* @example
* ```typescript
* await updateMeProfile({
* url: "https://api.asgardeo.io/t/<ORG>/scim2/Me",
* value: { "urn:scim:wso2:schema": { mobileNumbers: ["0777933830"] } }
* });
* ```
*/
declare const updateMeProfile: ({ url, payload, ...requestConfig }: {
url: string;
payload: any;
} & Partial<Request>) => Promise<User>;
export default updateMeProfile;