Skip to content

Commit e4b7ce4

Browse files
authored
Merge pull request #510 from Arobce/main
`fix:` reflect v5 react SDK changes in documentation
2 parents 7dad00c + b9b2328 commit e4b7ce4

File tree

1 file changed

+13
-39
lines changed

1 file changed

+13
-39
lines changed

src/content/docs/developer-tools/sdks/frontend/react-sdk.mdx

Lines changed: 13 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -623,44 +623,20 @@ Default: `openid profile email offline`
623623
624624
## **API References- useKindeAuth hook**
625625
626-
### **`createOrg`**
627-
628-
Constructs redirect url and sends user to Kinde to sign up and create a new org for your business.
629-
630-
Usage:
631-
632-
Arguments:
633-
634-
```typescript
635-
org_name?: string;
636-
app_state?: object;
637-
authUrlParams?: object;
638-
```
639-
640-
```jsx
641-
createOrg();
642-
```
643-
644-
Sample:
645-
646-
```jsx
647-
redirect;
648-
```
649-
650626
### `getClaim`
651627
652628
Gets a claim from an access or ID token.
653629
654630
Arguments:
655631
656632
```typescript
657-
claim: string, tokenKey?: string
633+
claim: string, tokenKey?: "accessToken" | "idToken"
658634
```
659635
660636
Usage:
661637
662638
```jsx
663-
getClaim("given_name", "id_token");
639+
getClaim("givenName", "idToken");
664640
```
665641
666642
Sample:
@@ -751,23 +727,23 @@ Sample:
751727
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c;
752728
```
753729

754-
### `getUser`
730+
### `getUserProfile`
755731

756732
Returns the profile for the current user.
757733

758734
Usage:
759735

760736
```jsx
761-
getUser();
737+
getUserProfile();
762738
```
763739

764740
Sample:
765741

766742
```jsx
767743
{
768-
given_name: "Dave";
744+
givenName: "Dave";
769745
id: "abcdef";
770-
family_name: "Smith";
746+
familyName: "Smith";
771747
772748
}
773749
```
@@ -797,9 +773,8 @@ Constructs redirect url and sends user to Kinde to sign in.
797773
Arguments:
798774

799775
```typescript
800-
org_code?: string;
801-
app_state?: object;
802-
authUrlParams?: object;
776+
orgCode?: string;
777+
state?: object;
803778
```
804779

805780
Usage:
@@ -821,7 +796,7 @@ Logs the user out of Kinde.
821796
Argument:
822797

823798
```typescript
824-
org_code?: string
799+
orgCode?: string
825800
```
826801

827802
Usage:
@@ -843,9 +818,8 @@ Constructs redirect url and sends user to Kinde to sign up.
843818
Arguments:
844819

845820
```typescript
846-
org_code?: string;
847-
app_state?: object;
848-
authUrlParams?: object;
821+
orgCode?: string;
822+
state?: object;
849823
```
850824

851825
Usage:
@@ -869,13 +843,13 @@ Gets a claim from an access or ID token.
869843
Arguments:
870844

871845
```typescript
872-
claim: string, tokenKey?: string
846+
claim: string, tokenKey?: "accessToken" | "idToken"
873847
```
874848

875849
Usage:
876850

877851
```jsx
878-
getClaim("given_name", "id_token");
852+
getClaim("given_name", "idToken");
879853
```
880854

881855
Sample:

0 commit comments

Comments
 (0)