Identity

Introduction

L'api identity permet d'obtenir des informations sur une méthodes d'identification de l'api, elle peut notament permettre de savoir si un access token est encore valide et pour combien de temps.

Structure

Objet Identity

Champ

Type

Description

type

string

Type d'entité accédant à l'application, voir types d'entités.

id

string

Id de l'entité, 32 caractères pours les applications et 8 pour les utilisateurs.

valid_until

?int

Durée de validité restante de l'identifiant en secondes. Vaut null en cas d'absence de fin de validité.

credential_type

string

Type d'identifiant, voir type types de tokens.

?scopes

string[]

Liste des permissions de l'identifiant. Présent seulement pour le type application.

Types d'entités

Valeur

Description

user

L'entité représentée par ce token est un utilisateur via un token OAuth 2.0.

application

L'entité représentée par ce token est une application utilisant l'authentification Basic.

Types de tokens

Valeur

access_token

refresh_token

basic

Endpoints de l'api

Ces endpoint sont les seul à accepter des tokens de rafraichissement pour le header Authorization.

L'api dispose des endpoints suivants pour les identifiants:

get
Obtenir les informations d'un identifiant

https://api.edu-focus.org/identity
Permet d'obtenir l'objet identity d'un identifiant.
Request
Response
Request
Headers
Authorization
required
string
L'identifiant à tester, sous la forme Bearer {token} pour les tokens d'accès et de rafraichissements et sous la forme Basic {base64} pour les identifiants d'applications.
Response
200: OK
Renvoie un objet identity dans le payload.
{
"status": "success",
"payload": {
"type": "application",
"id": "DkTXUSc1SzdWj7jUsq9x8UHKwC6yc2xK",
"valid_until": null,
"credential_type": "basic"
},
"code": 200
}
400: Bad Request
Code: invalid_authorization_header_type
=> Le header Authorization est d'un type autre que Basic ou Bearer
Code: invalid_authorization_header_value
=> Le header contient une valeur malformé

get
Obtenir l'application qui à demandé un identifiant

https://api.edu-focus.org/identity/source
Permet de savoir quelle application est à l'origine d'une méthode d'autentification.
Request
Response
Request
Headers
Authorization
required
string
L'identifiant à tester, sous la forme Bearer {token} pour les token d'accès et de rafraichissement et sous la forme Basic {base64} pour les identifiants d'application.
Response
200: OK
Renvoie un objet application dans le payload
{
"status": "success",
"payload": {
"id": "eSQhp4A7WqAIJCpgklQqy2JFUK5MQT6U",
"name": "A totally normal app",
"type": "classic"
},
"code": 200
}
400: Bad Request
Code: invalid_authorization_header_type
=> Le header Authorization est d'un type autre que Basic ou Bearer
Code: invalid_authorization_header_value
=> Le header contient une valeur malformé