Users

List Users

get

List users with cursor-based pagination, search, and sorting.

Filters:

• org_id: List all users in organization (requires org_admin or super_admin)

• team_id: List team members (requires team membership)

• project_id: List project members (requires project membership)

• search: Search by name or email (case-insensitive)

• sort_by: Sort by name, email, or created_at

• sort_order: asc or desc

• cursor: Pagination cursor for next page

• page_size: Items per page (1-100, default 50)

Returns paginated response with cursor for next page.

Query parameters

org_idany ofOptional

Filter by organization

stringOptional

or

nullOptional

team_idany ofOptional

Filter by team

stringOptional

or

nullOptional

project_idany ofOptional

Filter by project

stringOptional

or

nullOptional

searchany ofOptional

Search by name or email

stringOptional

or

nullOptional

sort_bystringOptional

Sort field: name, email, created_at

Default: created_at

sort_orderstringOptional

Sort order: asc or desc

Default: desc

cursorany ofOptional

Cursor for pagination

stringOptional

or

nullOptional

page_sizeinteger · min: 1 · max: 100Optional

Number of items per page

Default: 50

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Paginated response for users list.

totalintegerRequired

pageintegerRequired

page_sizeintegerRequired

has_morebooleanRequired

next_cursorany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/users

HTTPcURLJavaScriptPython

GET /v1/admin/users HTTP/1.1
Accept: */*

{
  "users": [
    {
      "user_id": "text",
      "user_email": "text",
      "user_name": "text",
      "user_picture": "text",
      "org_id": "text",
      "global_role": "text",
      "team_id": "text",
      "team_role": "text",
      "project_id": "text",
      "project_role": "text",
      "teams": [
        {
          "team_id": "text",
          "team_role": "text",
          "assigned_at": "text"
        }
      ],
      "projects": [
        {
          "project_id": "text",
          "project_role": "text",
          "team_id": "text",
          "assigned_at": "text"
        }
      ],
      "status": "text",
      "created_at": "text"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1,
  "has_more": true,
  "next_cursor": "text"
}

Get Current User Profile

get

Get current user's profile.

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for user.

user_idstringRequired

user_emailstringRequired

user_namestringRequired

user_pictureany ofOptional

stringOptional

or

nullOptional

org_idstringRequired

global_roleany ofOptional

stringOptional

or

nullOptional

team_idany ofOptional

stringOptional

or

nullOptional

team_roleany ofOptional

stringOptional

or

nullOptional

project_idany ofOptional

stringOptional

or

nullOptional

project_roleany ofOptional

stringOptional

or

nullOptional

statusstringRequired

created_atstringRequired

422

Validation Error

application/json

get

/v1/admin/users/me

HTTPcURLJavaScriptPython

GET /v1/admin/users/me HTTP/1.1
Accept: */*

{
  "user_id": "text",
  "user_email": "text",
  "user_name": "text",
  "user_picture": "text",
  "org_id": "text",
  "global_role": "text",
  "team_id": "text",
  "team_role": "text",
  "project_id": "text",
  "project_role": "text",
  "teams": [
    {
      "team_id": "text",
      "team_role": "text",
      "assigned_at": "text"
    }
  ],
  "projects": [
    {
      "project_id": "text",
      "project_role": "text",
      "team_id": "text",
      "assigned_at": "text"
    }
  ],
  "status": "text",
  "created_at": "text"
}

Update Current User Profile

patch

Update current user's profile.

Users can update their own profile information.

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request model for updating a user.

user_nameany ofOptional

stringOptional

or

nullOptional

preferencesany ofOptional

or

nullOptional

statusany ofOptional

stringOptional

or

nullOptional

global_roleany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for user.

user_idstringRequired

user_emailstringRequired

user_namestringRequired

user_pictureany ofOptional

stringOptional

or

nullOptional

org_idstringRequired

global_roleany ofOptional

stringOptional

or

nullOptional

team_idany ofOptional

stringOptional

or

nullOptional

team_roleany ofOptional

stringOptional

or

nullOptional

project_idany ofOptional

stringOptional

or

nullOptional

project_roleany ofOptional

stringOptional

or

nullOptional

statusstringRequired

created_atstringRequired

422

Validation Error

application/json

patch

/v1/admin/users/me

HTTPcURLJavaScriptPython

PATCH /v1/admin/users/me HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "user_name": "text",
  "preferences": {
    "default_team_id": "text",
    "default_project_id": "text",
    "theme": "light"
  },
  "status": "text",
  "global_role": "text"
}

{
  "user_id": "text",
  "user_email": "text",
  "user_name": "text",
  "user_picture": "text",
  "org_id": "text",
  "global_role": "text",
  "team_id": "text",
  "team_role": "text",
  "project_id": "text",
  "project_role": "text",
  "teams": [
    {
      "team_id": "text",
      "team_role": "text",
      "assigned_at": "text"
    }
  ],
  "projects": [
    {
      "project_id": "text",
      "project_role": "text",
      "team_id": "text",
      "assigned_at": "text"
    }
  ],
  "status": "text",
  "created_at": "text"
}

Get User

get

Get user details by ID.

Requires: read:users permission or same org membership

Path parameters

user_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for user.

user_idstringRequired

user_emailstringRequired

user_namestringRequired

user_pictureany ofOptional

stringOptional

or

nullOptional

org_idstringRequired

global_roleany ofOptional

stringOptional

or

nullOptional

team_idany ofOptional

stringOptional

or

nullOptional

team_roleany ofOptional

stringOptional

or

nullOptional

project_idany ofOptional

stringOptional

or

nullOptional

project_roleany ofOptional

stringOptional

or

nullOptional

statusstringRequired

created_atstringRequired

422

Validation Error

application/json

get

/v1/admin/users/{user_id}

HTTPcURLJavaScriptPython

GET /v1/admin/users/{user_id} HTTP/1.1
Accept: */*

{
  "user_id": "text",
  "user_email": "text",
  "user_name": "text",
  "user_picture": "text",
  "org_id": "text",
  "global_role": "text",
  "team_id": "text",
  "team_role": "text",
  "project_id": "text",
  "project_role": "text",
  "teams": [
    {
      "team_id": "text",
      "team_role": "text",
      "assigned_at": "text"
    }
  ],
  "projects": [
    {
      "project_id": "text",
      "project_role": "text",
      "team_id": "text",
      "assigned_at": "text"
    }
  ],
  "status": "text",
  "created_at": "text"
}

Delete User

delete

Delete (soft delete) a user.

Requires: delete:users permission (org_admin or super_admin)

Path parameters

user_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/admin/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /v1/admin/users/{user_id} HTTP/1.1
Accept: */*

No content

Update User

patch

Update user profile.

Authorization levels:

• super_admin/org_admin: Can update any user in their organization

• team_admin: Can update users within their team

• project_admin: Can update users within their project

Note: Users can update their own profile via PATCH /me endpoint.

Path parameters

user_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request model for updating a user.

user_nameany ofOptional

stringOptional

or

nullOptional

preferencesany ofOptional

or

nullOptional

statusany ofOptional

stringOptional

or

nullOptional

global_roleany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for user.

user_idstringRequired

user_emailstringRequired

user_namestringRequired

user_pictureany ofOptional

stringOptional

or

nullOptional

org_idstringRequired

global_roleany ofOptional

stringOptional

or

nullOptional

team_idany ofOptional

stringOptional

or

nullOptional

team_roleany ofOptional

stringOptional

or

nullOptional

project_idany ofOptional

stringOptional

or

nullOptional

project_roleany ofOptional

stringOptional

or

nullOptional

statusstringRequired

created_atstringRequired

422

Validation Error

application/json

patch

/v1/admin/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /v1/admin/users/{user_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "user_name": "text",
  "preferences": {
    "default_team_id": "text",
    "default_project_id": "text",
    "theme": "light"
  },
  "status": "text",
  "global_role": "text"
}

{
  "user_id": "text",
  "user_email": "text",
  "user_name": "text",
  "user_picture": "text",
  "org_id": "text",
  "global_role": "text",
  "team_id": "text",
  "team_role": "text",
  "project_id": "text",
  "project_role": "text",
  "teams": [
    {
      "team_id": "text",
      "team_role": "text",
      "assigned_at": "text"
    }
  ],
  "projects": [
    {
      "project_id": "text",
      "project_role": "text",
      "team_id": "text",
      "assigned_at": "text"
    }
  ],
  "status": "text",
  "created_at": "text"
}

Get User Memberships

get

Get all teams and projects a user is a member of.

Returns: - teams: List of teams with team_id, team_name, role, assigned_at - projects: List of projects with project_id, project_name, team_id, role, assigned_at

Requires: read:users permission or same org membership

Path parameters

user_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for user memberships.

user_idstringRequired

422

Validation Error

application/json

get

/v1/admin/users/{user_id}/memberships

HTTPcURLJavaScriptPython

GET /v1/admin/users/{user_id}/memberships HTTP/1.1
Accept: */*

{
  "user_id": "text",
  "teams": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "projects": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Invite User

post

Invite a user with a specific role.

For organization-level roles (org_admin, member), no team_id/project_id required. For team roles (team_admin, team_member), team_id is required. For project roles (project_admin, editor, viewer), project_id is required.

Flow:

1. Creates user record with status="invited" (or updates if re-inviting)

2. Assigns the specified team/project role

3. Sends invitation email via ECS (background task)

4. User activates on first SSO login

Requires: appropriate write permissions based on role level

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to invite a user to team or project.

user_emailstring · emailRequired

rolestring · enumRequired

Role types in the system.

Possible values:

team_idany ofOptional

stringOptional

or

nullOptional

project_idany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/users/invite

HTTPcURLJavaScriptPython

POST /v1/admin/users/invite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "user_email": "[email protected]",
  "role": "super_admin",
  "team_id": "text",
  "project_id": "text"
}

{
  "user": {
    "user_id": "text",
    "user_email": "text",
    "user_name": "text",
    "user_picture": "text",
    "org_id": "text",
    "global_role": "text",
    "team_id": "text",
    "team_role": "text",
    "project_id": "text",
    "project_role": "text",
    "teams": [
      {
        "team_id": "text",
        "team_role": "text",
        "assigned_at": "text"
      }
    ],
    "projects": [
      {
        "project_id": "text",
        "project_role": "text",
        "team_id": "text",
        "assigned_at": "text"
      }
    ],
    "status": "text",
    "created_at": "text"
  },
  "invitation_sent": true,
  "message": "text",
  "email_status": "text"
}

Get My Teams

get

Get current user's accessible teams.

Access Rules:

• super_admin/org_admin: ALL teams in organization

• Others: Only teams they are explicitly members of

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get

/v1/admin/users/me/teams

HTTPcURLJavaScriptPython

GET /v1/admin/users/me/teams HTTP/1.1
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

Get My Projects

get

Get current user's accessible projects with metadata.

Access Rules:

• super_admin/org_admin: ALL projects in organization (or filtered by team_id)

• team_admin/team_member: ALL projects in their team(s) (implicit access)

• project_admin/editor/viewer: Only explicit project memberships

Response includes:

• 'access_type': 'implicit' (inherited from team) or 'explicit' (directly assigned)

• 'metadata': Project custom_metadata (if include_metadata=true)

• 'settings': Project settings (rate_limit, allowed_services)

Query Parameters:

• team_id: Filter projects by team (optional). Consumer apps can pass their team_id to get only projects relevant to them.

• include_metadata: Include project metadata in response (default: true)

Query parameters

team_idany ofOptional

stringOptional

or

nullOptional

include_metadatabooleanOptionalDefault: true

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get

/v1/admin/users/me/projects

HTTPcURLJavaScriptPython

GET /v1/admin/users/me/projects HTTP/1.1
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]