Administrative-Org Admin

User and organization management performed by admins of the platform’s administrative organization. All paths below are relative to /api/v1.

Auth: every endpoint requires a valid token, an organization supplied via the ?org=<slug> query parameter, and the admin_of_administrative_org authorization relation. Send the token as a header:

curl -H "Authorization: token $AKP_TOKEN" \
  "https://<akp-host>/api/v1/admin/orgs?org=appscode"

All endpoints accept the common query parameter:

Organizations

GET /admin/orgs

List all organizations on the platform.

• Auth: token + ?org= + admin_of_administrative_org.
• Response: 200 — an array of Organization objects.

[
  {
    "id": 3,
    "username": "appscode",
    "full_name": "",
    "avatar_url": "https://<akp-host>/accounts/avatars?obj=avatars/3-<hash>",
    "description": "",
    "website": "",
    "location": "",
    "rancherManagementClusterEndPoint": "",
    "visibility": "public",
    "orgType": 6
  }
]

Verified: GET returned 200 against appscode on 2026-07-14.

Users

GET /admin/users

List all users on the platform.

• Auth: token + ?org= + admin_of_administrative_org.
• Response: 200 — an array of User objects.

[
  {
    "id": 5,
    "login": "example-user",
    "username": "example-user",
    "full_name": "Example User",
    "email": "[email protected]",
    "avatar_url": "https://<akp-host>/accounts/avatars?obj=avatars/5-<hash>",
    "is_admin": false,
    "active": true,
    "type": 0,
    "created": "2026-01-01T00:00:00Z",
    "last_login": "2026-07-01T00:00:00Z"
  }
]

Verified: GET returned 200 against appscode on 2026-07-14.

POST /admin/users

Create a user.

• Auth: token + ?org= + admin_of_administrative_org.
• Request body: CreateUserOption.

{
  "username": "example-user",
  "email": "[email protected]",
  "password": "<password>",
  "full_name": "Example User",
  "login_name": "example-user",
  "source_id": 0,
  "must_change_password": true,
  "send_notify": true
}

• Response: 201 — the created User.

PATCH /admin/users/{username}

Edit an existing user.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Request body: EditUserOption.

{
  "email": "[email protected]",
  "full_name": "Example User",
  "active": true,
  "admin": false,
  "prohibit_login": false,
  "allow_create_organization": true
}

• Response: 200 — the updated User.

DELETE /admin/users/{username}

Delete a user.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Response: 204 — no content.

POST /admin/users/{username}/update

Update a user’s profile as admin.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Request body: Profile.

{
  "name": "example-user",
  "full_name": "Example User",
  "email": "[email protected]",
  "keep_email_private": false,
  "website": "https://example.com",
  "location": "Earth",
  "language": "en-US",
  "description": "Platform user"
}

• Response: 200 — the updated Profile.

POST /admin/users/{username}/change-password

Change a user’s password as admin.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Request body: UpdatePasswordParams.

{
  "old_password": "<old-password>",
  "password": "<new-password>",
  "retype": "<new-password>"
}

• Response: 200 — password updated.

GET /admin/users/{username}/orgs

List the organizations a user belongs to.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Response: 200 — a list of organizations (the response shape is delegated to the org listing handler; it is returned as an untyped JSON object/array).

Verified: GET returned 200 against appscode (user appscode) on 2026-07-14.

POST /admin/users/{username}/orgs

Create an organization owned by the given user.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

• Request body: CreateOrgOption.

{
  "username": "new-org",
  "full_name": "New Org",
  "description": "Example organization",
  "website": "https://example.com",
  "location": "Earth",
  "orgType": "public",
  "visibility": "public"
}

• Response: 201 — the created Organization.

GET /admin/users/{uid}

Get user information by numeric user ID.

• Auth: token + ?org= + admin_of_administrative_org.
• Path parameters:

Note: this shares the /admin/users/{...} path with the username-based routes above; supply a numeric ID here to look a user up by ID.

• Response: 200 — a User object.

Verified: returned 404 against appscode (uid 1) on 2026-07-14 — no user with that ID exists; the endpoint is reachable and authorized.