diff options
| author | Imre <ifarkas@gitlab.com> | 2018-05-18 10:49:02 +0200 |
|---|---|---|
| committer | Imre Farkas <ifarkas@gitlab.com> | 2018-06-06 10:12:52 +0200 |
| commit | c8f0e4b5da0c9d578035e74b524f5adcb80efcf6 (patch) | |
| tree | 4e0a2624c77f42bebf1d06098074c61115828b2f /doc/api/avatar.md | |
| parent | fe0ebf76c49e2512b211c5d43152275c536f7e3a (diff) | |
| download | gitlab-ce-c8f0e4b5da0c9d578035e74b524f5adcb80efcf6.tar.gz | |
Add Avatar API
Diffstat (limited to 'doc/api/avatar.md')
| -rw-r--r-- | doc/api/avatar.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/api/avatar.md b/doc/api/avatar.md new file mode 100644 index 00000000000..7faed893066 --- /dev/null +++ b/doc/api/avatar.md @@ -0,0 +1,33 @@ +# Avatar API + +> [Introduced][ce-19121] in GitLab 11.0 + +## Get a single avatar URL + +Get a single avatar URL for a given email addres. If user with matching public +email address is not found, results from external avatar services are returned. +This endpoint can be accessed without authentication. In case public visibility +is restricted, response will be `403 Forbidden` when unauthenticated. + +``` +GET /avatar?email=admin@example.com +``` + +| Attribute | Type | Required | Description | +| --------- | ------- | -------- | --------------------- | +| `email` | string | yes | Public email address of the user | +| `size` | integer | no | Single pixel dimension (since images are squares). Only used for avatar lookups at `Gravatar` or at the configured `Libravatar` server | + +```bash +curl https://gitlab.example.com/api/v4/avatar?email=admin@example.com +``` + +Example response: + +```json +{ + "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon" +} +``` + +[ce-19121]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/19121 |