ncaron
/
auth
mirror of https://gitlab.com/mobicoop/v3/service/auth.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
sbriat 2023-07-13 10:17:38 +02:00
parent 5cccb8252b
commit 82601ff780
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -59,23 +59,27 @@ Note that all usernames are unique in the system : many users can't have the sam
For AuthN, the app exposes the following [gRPC](https://grpc.io/) services : For AuthN, the app exposes the following [gRPC](https://grpc.io/) services :
- **Create** : create an auth with one username / password (you can't create multiple usernames at once) - **Create** : create an auth with usernames and a password
```json ```json
{ {
"uuid": "30f49838-3f24-42bb-a489-8ffb480173ae", "userId": "30f49838-3f24-42bb-a489-8ffb480173ae",
"username": "john.doe@email.com", "usernames": [
"password": "John123", {
"name": "john.doe@email.com",
"type": "EMAIL" "type": "EMAIL"
} }
],
"password": "John123"
}
``` ```
- **AddUsername** : add a username to an auth - **AddUsername** : add a username to an auth
```json ```json
{ {
"uuid": "30f49838-3f24-42bb-a489-8ffb480173ae", "userId": "30f49838-3f24-42bb-a489-8ffb480173ae",
"username": "+33611223344", "name": "+33611223344",
"type": "PHONE" "type": "PHONE"
} }
``` ```
@ -84,8 +88,8 @@ For AuthN, the app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"uuid": "30f49838-3f24-42bb-a489-8ffb480173ae", "userId": "30f49838-3f24-42bb-a489-8ffb480173ae",
"username": "johnny.doe@email.com", "name": "johnny.doe@email.com",
"type": "EMAIL" "type": "EMAIL"
} }
``` ```
@ -94,7 +98,7 @@ For AuthN, the app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"username": "+33611223344" "name": "+33611223344"
} }
``` ```
@ -102,16 +106,16 @@ For AuthN, the app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"uuid": "30f49838-3f24-42bb-a489-8ffb480173ae", "userId": "30f49838-3f24-42bb-a489-8ffb480173ae",
"password": "Johnny123" "password": "Johnny123"
} }
``` ```
- **Validate** : validate an auth (= authentication with username/password) - **Validate** : validate an auth (= authentication with name/password)
```json ```json
{ {
"username": "john.doe@email.com", "name": "john.doe@email.com",
"password": "Johnny123" "password": "Johnny123"
} }
``` ```
@ -120,7 +124,7 @@ For AuthN, the app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"uuid": "30f49838-3f24-42bb-a489-8ffb480173ae" "userId": "30f49838-3f24-42bb-a489-8ffb480173ae"
} }
``` ```
@ -134,7 +138,7 @@ For AuthZ, the app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"uuid": "96d99d44-e0a6-458e-a656-de2a400d60a9", "userId": "96d99d44-e0a6-458e-a656-de2a400d60a9",
"domain": "USER", "domain": "USER",
"action": "READ", "action": "READ",
"context": [ "context": [