zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-06-10 14:44:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1005 from internetee/fix-documentation

Browse source 
Fix documentation
This commit is contained in:
Timo Võhmar 2018-10-17 16:24:51 +03:00 • committed by GitHub
commit b7773d11a0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/registrant-api/v1/authentication.md
View file

@ -4,14 +4,14 @@
For specified partners the API allows for use of data from mobile ID for
authentication. API client should perform authentication with eID according to
the approriate documentation, and then pass on values from the webserver's
the appropriate documentation, and then pass on values from the web server's
certificate to the API server.
## POST /api/v1/registrant/auth/eid
Returns a bearer token to be used for further API requests. Tokens are valid for 2 hours since their creation.
#### Paramaters
#### Parameters
Values in brackets represent values that come from the id card certificate.
@ -24,7 +24,7 @@ Values in brackets represent values that come from the id card certificate.
#### Request
```
POST /api/v1/auth/token HTTP/1.1
POST /api/v1/registrant/auth/token HTTP/1.1
Accept: application/json
Content-type: application/json
@ -48,9 +48,9 @@ Content-Type: application/json
}
```
## POST /api/v1/auth/username -- NOT IMPLEMENTED
## POST /api/v1/registrant/auth/username -- NOT IMPLEMENTED
#### Paramaters
#### Parameters
Values in brackets represent values that come from the id card certificate
@ -62,7 +62,7 @@ Values in brackets represent values that come from the id card certificate
#### Request
```
POST /api/v1/auth/token HTTP/1.1
POST /api/v1/registrant/auth/token HTTP/1.1
Accept: application/json
Content-type: application/json
```
@ -82,7 +82,7 @@ Content-Type: application/json
## Implementation notes:
We do not need to store the session data at all, instead we can levarage AES encryption and use
We do not need to store the session data at all, instead we can leverage AES encryption and use
Rails secret as the key. General approximation:
```ruby
@ -101,7 +101,7 @@ class AuthenticationToken
{
token: base64_encoded,
expires_in = values[:expires_in]
expires_in: values[:expires_in],
type: "Bearer"
}
end