Skip to content

Commit 7206454

Browse files
committed
update README
1 parent 36a28c0 commit 7206454

File tree

1 file changed

+1
-29
lines changed

1 file changed

+1
-29
lines changed

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This library interacts directly with our authentication provider [AWS Cognito](h
1212
pip install scribeauth
1313
```
1414

15-
This library requires Python >= 3.10 that supports typing.
15+
This library requires Python >= 3.11 that supports typing.
1616

1717
## Methods
1818

@@ -58,30 +58,6 @@ access = ScribeAuth(client_id)
5858
access.revoke_refresh_token('refresh_token')
5959
```
6060

61-
### 5. Getting federated id
62-
63-
```python
64-
from scribeauth import ScribeAuth
65-
access = ScribeAuth({'client_id': your_client_id, 'user_pool_id': your_user_pool_id, 'identity_pool_id': your_identity_pool_id})
66-
access.get_federated_id('your_id_token')
67-
```
68-
69-
### 6. Getting federated credentials
70-
71-
```python
72-
from scribeauth import ScribeAuth
73-
access = ScribeAuth({'client_id': your_client_id, 'user_pool_id': your_user_pool_id, 'identity_pool_id': your_identity_pool_id})
74-
access.get_federated_credentials('your_federated_id', 'your_id_token')
75-
```
76-
77-
### 7. Getting signature for request
78-
79-
```python
80-
from scribeauth import ScribeAuth
81-
access = ScribeAuth({'client_id': your_client_id, 'user_pool_id': your_user_pool_id, 'identity_pool_id': your_identity_pool_id})
82-
access.get_signature_for_request(request='your_request', credentials='your_federated_credentials')
83-
```
84-
8561
## Flow
8662

8763
- If you never have accessed your Scribe account, it probably still contains the temporary password we generated for you. You can change it directly on the [platform](https://platform.scribelabs.ai) or with the `change_password` method. You won't be able to access anything else until the temporary password has been changed.
@@ -92,10 +68,6 @@ access.get_signature_for_request(request='your_request', credentials='your_feder
9268

9369
- In case you suspect that your refresh token has been leaked, you can revoke it with `revoke_token`. This will also invalidate any access/id token that has been issued with it. In order to get a new one, you'll need to use your username and password again.
9470

95-
- You can get your federated id by using `get_federated_id` and providing your id token. The federated id will allow you to use `get_federated_credentials` to get an access key id, secret key and session token.
96-
97-
- Every API call to be made to Scribe's API Gateway needs to have a signature. You can get the signature for your request by using `get_signature_for_request`. Provide the request you'll be using and your credentials (use `get_federated_credentials` to get them).
98-
9971
## Command line
10072

10173
You can also use the package as follows for quick access to tokens:

0 commit comments

Comments
 (0)