---
title: "Retrieve auth"
method: POST
path: "/auth.info"
tags: ["Auth"]
---

# Retrieve auth

`POST /auth.info`

Retrieve authentication details for the current API key

## Response `200`

OK

- object
  - `data` Auth
    - `user` User
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean — Whether this user has been suspended.
      - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
      - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
    - `team` Team
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of this team, it is usually auto-generated when the first SSO connection is made but can be changed if neccessary.
      - `avatarUrl` string, uri — The URL for the image associated with this team, it will be displayed in the team switcher and in the top left of the knowledge base along with the name.
      - `sharing` boolean — Whether this team has share links globally enabled. If this value is false then all sharing UI and APIs are disabled.
      - `defaultCollectionId` string, uuid — If set then the referenced collection is where users will be redirected to after signing in instead of the Home screen
      - `defaultUserRole` 'admin' | 'member' | 'viewer' | 'guest'
      - `memberCollectionCreate` boolean — Whether members are allowed to create new collections. If false then only admins can create collections.
      - `documentEmbeds` boolean — Whether this team has embeds in documents globally enabled. It can be disabled to reduce potential data leakage to third parties.
      - `collaborativeEditing` boolean — Whether this team has collaborative editing in documents globally enabled.
      - `inviteRequired` boolean — Whether an invite is required to join this team, if false users may join with a linked SSO provider.
      - `allowedDomains` string[]
      - `guestSignin` boolean — Whether this team has guest signin enabled. Guests can signin with an email address and are not required to have a Google Workspace/Slack SSO account once invited.
      - `subdomain` string — Represents the subdomain at which this team's knowledge base can be accessed.
      - `url` string, uri — The fully qualified URL at which this team's knowledge base can be accessed.

## Other responses

- `401` — The API key is missing or otherwise invalid.
- `429` — The request was rate limited.

## Changes

- **2024-10-18** `fdf2ec9c9df4` — 1 info
  - added the non-success response with the status `429`
- **2024-07-06** `7b33b538cd7d` — 3 info
  - added the optional property `data` to the response with the `401` status
  - added the optional property `message` to the response with the `401` status
  - added the optional property `status` to the response with the `401` status

[Change history](https://skmtc.dev/defaulr/apis/outline-api/changes/auth.info/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) · [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/defaulr/outline-api/revisions/fdf2ec9c9df4/schema)