Skip to main content
POST
/
api
/
auth
/
me
Me
curl --request POST \
  --url https://copilotz.com/api/auth/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "_id": 1,
  "provider": "email",
  "username": "[email protected]",
  "name": "John Doe",
  "profile": 1,
  "workspace": {
    "_id": 4,
    "name": "My Workspace",
    "namespace": "my-workspace-namespace",
    "host": "my-workspace-namespace.copilotz.com",
    "status": "active",
    "createdAt": "2024-09-17T16:52:28.684Z",
    "updatedAt": "2024-09-17T16:52:28.684Z",
    "context": {}
  },
  "role": {
    "_id": 2,
    "name": "WORKSPACE_ADMIN",
    "permissions": [
      {
        "schema": "['users', 'roles'].indexOf({{resource}}) < 0",
        "read": "{{account.workspace._id}}",
        "write": "{{account.workspace._id}}"
      }
    ],
    "createdAt": "2024-08-14T18:38:39.118Z",
    "updatedAt": "2024-08-14T18:38:39.118Z"
  },
  "createdAt": "2024-08-15T18:49:02.068Z",
  "updatedAt": "2024-08-15T18:49:02.068Z",
  "context": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The body is of type object.

Response

OK

Response containing current authenticated user information.

​
_id
integer
required

Unique identifier for the user.

Example:

1

​
provider
string
required

Authentication provider.

Example:

"email"

​
username
string<email>
required

User's email address.

Example:

"[email protected]"

​
name
string
required

Full name of the user.

Example:

"John Doe"

​
profile
integer
required

Profile identifier associated with the user.

Example:

1

​
workspace
object
required

Workspace details associated with the user.

​
role
object
required

Role details assigned to the user.

​
createdAt
string<date-time>
required

Timestamp when the user was created.

Example:

"2024-08-15T18:49:02.068Z"

​
updatedAt
string<date-time>
required

Timestamp when the user was last updated.

Example:

"2024-08-15T18:49:02.068Z"

​
context
object

Additional context for the user.