Developer Center
Pesquisar K

Appearance

Informações de usuário​

GET
/v1/oauth/user/info

Visualizar informações de um usuário. As informações que serão retornadas dependem do escopo do seu app bem como dos valores passados na chave includes. Para que a rota retorne as informações de membros, grupos ou comunidades relacionadas seu app deve passar na chave includes da querystring os valores members, groups ou community. Caso deseje retornar mais de uma dessas informações separe os valores por vírgulas na chave includes.

Autorizações​

OAuth2
authorizationCode Flow
Authorization URL"https://id.layers.digital"
Token URL"https://api.layers.digital/oauth/token"
Scopes:
  • "openid"Garante acesso ao id da conta do usuário
  • "profile"Garante acesso às informações do perfil do usuário
  • "fullname"Garante acesso ao nome do usuário
  • "email"Garante acesso ao e-mail do usuário
  • "related.communities"Garante acesso a informações das comunidades às quais o usuário está vinculado
  • "related.groups"Garante acesso a informações dos grupos aos quais o usuário está vinculado
  • "related.members"Garante acesso a informações dos alunos vinculados ao usuário
  • "related.members.groups"Garante acesso a informações dos grupos aos quais alunos vinculados com o usuário estão vinculados

Respostas​

Informações de usuário cujo escopo do app dá acesso

application/json
JSON
{
"user": {
"lastSeenAt": "string",
"id": "string",
"createdAt": "string",
"UpdatedAt": "string",
"Alias": "user1",
"roles": [
"string"
],
"permissions": [
"string"
]
},
"community": {
"color": "string",
"community": "test",
"icon": "string",
"name": "string"
},
"groups": [
{
"id": "string",
"name": "Primeiro Ano",
"alias": "primeiro-ano",
"createdAt": "string",
"updatedAt": "string",
"season": 2020,
"enrollment": {
"id": "string",
"kind": "member",
"entity": "string",
"group": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
],
"Members": [
{
"name": "João Pedro Silva",
"createdAt": "string",
"updatedAt": "string",
"alias": "member1",
"id": "string",
"groups": [
{
"id": "string",
"name": "Primeiro Ano",
"alias": "primeiro-ano",
"createdAt": "string",
"updatedAt": "string",
"season": 2020,
"enrollment": {
"id": "string",
"kind": "member",
"entity": "string",
"group": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
]
}
]
}

Exemplos​

cURL
JavaScript
PHP
Python