CompteQui suis-je
Retour à Sofia

Compte

Qui suis-je

Décrit le jeton appelant : type, application, personne pour qui il agit, Workspaces, permissions, mode et expiration. Tout jeton valide peut le lire.

GEThttps://api.sofia-post.com/api/v1/me
GET/v1/me
curl -X GET 'https://api.sofia-post.com/api/v1/me' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Autorisations

  • Authorizationstringrequis

    Votre clé personnelle ou jeton d’accès OAuth, envoyé sous la forme Bearer <token>.

Réponse

200application/json

L’identité et les permissions du jeton appelant.

  • tokenTypestringrequis

    Type de jeton : personal_key, authorization_code ou client_credentials

    Valeurs autorisées : personal_keyauthorization_codeclient_credentials

  • applicationobjectrequis

    L’application derrière le jeton

    Afficher les attributs enfants
    • idstringrequis

      Identifiant de l’application (ou de la clé personnelle)

    • clientIdstringrequis

      Le client_id de l’application

    • namestringrequis

      Nom de l’application

  • userobjectrequis

    La personne pour qui le jeton agit

    Afficher les attributs enfants
    • idstringrequis

      La personne pour qui le jeton agit : l’auteur de la clé, ou qui a donné son consentement

  • coveragestringrequis

    workspace : un seul Workspace ; account : tous ceux dont l’auteur de la clé est membre

    Valeurs autorisées : workspaceaccount

  • workspacesobject[]requis

    Où le jeton agit maintenant

    Afficher les attributs enfants
    • idstringrequis

      Identifiant du Workspace

    • namestringrequis

      Nommé d’après ses établissements actifs

  • scopesstring[]requis

    Permissions détenues par le jeton

  • modestringrequis

    test ou live

    Valeurs autorisées : testlive

  • expiresAtstring<date-time>

    Moment où le jeton expire ; absent pour une clé sans expiration

4XXapplication/json

Toute autre erreur, dans l’enveloppe d’erreur.