Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.4.x (latest)
  • Home icon
  • Kong Gateway
  • Admin API
  • Admins
  • Admins Reference
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • List Admins
  • Invite an Admin
  • Register an Admin’s Credentials
  • Send a Password-Reset Email to an Admin
  • Reset an Admin’s Password
  • Retrieve an Admin
  • Update an Admin
  • Delete an Admin
  • List an Admin’s Roles
  • Create or Update an Admin’s Roles
  • Delete an Admin’s Role
  • List an Admin’s Workspaces

Admins Reference

List Admins

Endpoint

/admins

Response

HTTP 200 OK
{
  "data": [{
    "created_at": 1556638385,
    "id": "665b4070-541f-48bf-82c1-53030babaa81",
    "updated_at": 1556638385,
    "status": 4,
    "username": "test-admin",
    "email": "test@test.com",
    "rbac_token_enabled": true
  }, {
    "created_at": 1556563122,
    "id": "a93ff120-9e6c-4198-b47e-f779104c7eac",
    "updated_at": 1556563122,
    "status": 0,
    "username": "kong_admin",
    "rbac_token_enabled": false
  }],
  "next": null
}

The status field in the response indicates if the admin has accepted their invitation:

Code Status
0 Approved
1 Pending
2 Rejected
3 Revoked
4 Invited
5 Unverified

Invite an Admin

Endpoint

/admins
Attribute Description
email The Admin’s email address
username The Admin’s username
custom_id
optional
The Admin’s custom ID
rbac_token_enabled Allows the Admin to use and reset their RBAC token; true by default

Response

HTTP 200 OK
{
  "admin": {
    "created_at": 1556638641,
    "id": "8f0a742f-07f3-49e0-90d7-4fc7eea7e6a4",
    "updated_at": 1556638641,
    "status": 4,
    "username": "test-case-3",
    "email": "test3@test.com",
    "rbac_token_enabled": true
  }
}

Register an Admin’s Credentials

Endpoint

/admins/register
Attribute Description
token The authentication token
username The Admin’s username
email The Admin’s email address
password The Admin’s new password

Response

HTTP 201 Created

Send a Password-Reset Email to an Admin

Endpoint

/admins/password_resets
Attribute Description
email The Admin’s email address

Response

HTTP 201 Created

Reset an Admin’s Password

Endpoint

/admins/password_resets
Attribute Description
email The Admin’s email address
password The Admin’s new password
token The authentication token

Response

HTTP 200 OK

Retrieve an Admin

Endpoint

/admins/{name_or_id}
Attribute Description
name_or_id The Admin’s username or ID
generate_register_url
optional
true returns a unique registration URL for the Admin

Notes:

  • generate_register_url will only generate a URL if the Admin’s invitation status is 4 (“invited”).
  • generate_register_url will override the previous registration URL for the particular Admin each time it is requested.

Response

HTTP 200 OK
{
  "created_at": 1556638385,
  "id": "665b4070-541f-48bf-82c1-53030babaa81",
  "updated_at": 1556638385,
  "status": 4,
  "username": "test-admin",
  "email": "test@test.com",
  "rbac_token_enabled": true
}

Update an Admin

Endpoint

/admins/{name_or_id}
Attribute Description
name_or_id The Admin’s current username or custom ID
email
optional
The Admin’s new email address
username
optional
The Admin’s new username
custom_id
optional
The Admin’s new custom ID
rbac_token_enabled Allows the Admin to use and reset their RBAC token; true by default

Response

HTTP 200 OK
{
  "created_at": 1556638385,
  "id": "665b4070-541f-48bf-82c1-53030babaa81",
  "updated_at": 1556639017,
  "status": 4,
  "username": "test-renamed",
  "email": "test@test.com"
  "rbac_token_enabled": true
}

Delete an Admin

Endpoint

/admins/{name_or_id}
Attribute Description
name_or_id The Admin’s username or ID

Response

HTTP 204 No Content

List an Admin’s Roles

Endpoint

/admins/{name_or_id}/roles
Attribute Description
name_or_id The Admin’s username or ID

Response

HTTP 200 OK
{
  "roles": [{
    "comment": "Read access to all endpoints, across all workspaces",
    "created_at": 1556563122,
    "id": "7574eb1d-c9fa-46a9-bd3a-3f1b4b196287",
    "name": "read-only",
    "is_default": false
  }, {
    "comment": "Full access to all endpoints, across all workspaces—except RBAC Admin API",
    "created_at": 1556563122,
    "id": "7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d",
    "name": "admin",
    "is_default": false
  }]
}

Create or Update an Admin’s Roles

Endpoint

/admins/{name_or_id}/roles
Attribute Description
name_or_id The Admin’s current username or ID
roles (comma separated) string of names of Roles to create or update for an Admin

Response

HTTP 201 OK
{
  "roles": [{
    "comment": "Read access to all endpoints, across all workspaces",
    "created_at": 1556563122,
    "id": "7574eb1d-c9fa-46a9-bd3a-3f1b4b196287",
    "name": "read-only",
    "is_default": false
  }, {
    "comment": "Full access to all endpoints, across all workspaces—except RBAC Admin API",
    "created_at": 1556563122,
    "id": "7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d",
    "name": "admin",
    "is_default": false
  }, {
    "comment": "Full access to all endpoints, across all workspaces",
    "created_at": 1556563122,
    "id": "99bd8d18-f5b6-410e-aefe-d75f4252f13c",
    "name": "super-admin",
    "is_default": false
  }]
}

Delete an Admin’s Role

Endpoint

/admins/{name_or_id}/roles
Attribute Description
name_or_id The Admin’s current username or custom ID
roles (comma separated) string of names of Roles to remove from an Admin

Response

HTTP 204 No Content

List an Admin’s Workspaces

Endpoint

/admins/{name_or_id}/workspaces
Attribute Description
name_or_id The Admin’s username or ID

Response

HTTP 200 OK
[{
  "created_at": 1556563122,
  "config": {
    "portal": true,
    "portal_auto_approve": true
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "default",
  "meta": {}
}, {
  "created_at": 1556570807,
  "config": {
    "portal": true
  },
  "id": "57b3ce24-6d29-427f-af13-15bd60430e56",
  "name": "sdfgsdfg",
  "meta": {
    "color": "#3894f0"
  }
}]
Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023