Skip to content

Commit

Permalink
add docs for api
Browse files Browse the repository at this point in the history
  • Loading branch information
marcvs committed Dec 1, 2023
1 parent e65aa56 commit 28eab32
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion alise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,28 @@ To get an API Key you need to be authorized via openid connect. We use
this solely to record who (sub, iss, email, name) requested which api-key

```
http http://localhost:8000/api/v1/target/vega-kc/get_apikey "Authorization: Bearer `oidc-token egi`"
http https://alise.data.kit.edu/api/v1/target/vega-kc/get_apikey "Authorization: Bearer `oidc-token egi`"
or
curl https://alise.data.kit.edu/api/v1/target/vega-kc/get_apikey -H "Authorization: Bearer `oidc-token egi`" | jq .
```


### Get a mapping from external to internal user

Note that the issuer needs to be urlencoded twice.

```
http https://alise.data.kit.edu/api/v1/target/vega-kc/mapping/issuer/`urlencode.py <issuer>`/user/`urlencode.py <subject>`?apikey=<apikey>
or
curl https://alise.data.kit.edu/api/v1/target/vega-kc/mapping/issuer/`urlencode.py <issuer>`/user/`urlencode.py <subject>`?apikey=<apikey> | jq .
```

## Installation

Account LInking SErvice is available on [PyPI](https://pypi.org/project/alise/). Install using `pip`:
```
pip install alise
Expand Down

0 comments on commit 28eab32

Please sign in to comment.