User Management

Overview

User management APIs in Akto allow you to manage access control and team membership within your organization. You can use these APIs to retrieve team details, invite new users, and remove existing users.

Available Endpoints

Method	Endpoint	Description
POST	/api/getTeamData	Retrieves information about the current team, including user roles and details
POST	/api/inviteUsers	Sends invitations to new users to join your Akto workspace
POST	/api/removeUser	Removes an existing user from your Akto workspace

POST request for endpoint /api/getTeamData

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request parameters required

Responses

200

Successfully fetched team data

application/json

List of users and pending invitations

idinteger · int32OptionalExample: 1001

loginstringOptionalExample: [e-mail]

namestringOptionalExample: John Doe

rolestringOptional

User role in the account

Example: ADMIN

post/api/getTeamData

HTTPcURLJavaScriptPython

POST /api/getTeamData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successfully fetched team data

[
  {
    "id": 1001,
    "login": "[e-mail]",
    "name": "John Doe",
    "role": "ADMIN"
  }
]

POST request for endpoint /api/inviteUsers

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

User invitation request with email and role

inviteeEmailstringRequired

Email address of the user to invite. Must be valid email format and belong to same organization domain

Example: [e-mail]

inviteeNamestringOptional

Name of the user being invited

Example: there

inviteeRolestringRequired

Role to assign to invited user. Valid values: ADMIN, MEMBER, DEVELOPER, VIEWER, or custom role names. Must be within current user's role hierarchy

Example: DEVELOPER

websiteHostNamestringOptional

Website host name for the invitation link

Example: https://app.akto.io

Responses

200

Invitation sent successfully

application/json

Successful invitation response containing the invite link and role

finalInviteCodestringOptional

Complete invitation link to be sent to the invitee. Contains JWT code valid for 1 week

Example: https://app.akto.io/addUserToAccount?signupInvitationCode=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&signupEmailId=[e-mail]

inviteeRolestringOptional

Role assigned to the invited user

Example: DEVELOPER

400

Invitation request validation failed

application/json

post/api/inviteUsers

HTTPcURLJavaScriptPython

POST /api/inviteUsers HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "inviteeEmail": "[e-mail]",
  "inviteeName": "there",
  "inviteeRole": "DEVELOPER",
  "websiteHostName": "https://app.akto.io"
}

{
  "finalInviteCode": "https://app.akto.io/addUserToAccount?signupInvitationCode=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&signupEmailId=[e-mail]",
  "inviteeRole": "DEVELOPER"
}

POST request for endpoint /api/removeUser

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

User removal request with email

emailstringRequired

Email address of the user to remove from the account

Example: [e-mail]

Responses

200

User removed or invitation deleted successfully

application/json

Successful removal response

emailstringOptional

idinteger · int32OptionalExample: 0

passwordResetTokennullOptional

roleHierarchystringOptionalExample: SUCCESS

userRoleHierarchystring[]OptionalExample: ["ADMIN","MEMBER","DEVELOPER","GUEST"]

usersnullOptional

400

User removal failed

application/json

post/api/removeUser

HTTPcURLJavaScriptPython

POST /api/removeUser HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "email": "[e-mail]"
}

{
  "email": "",
  "id": 0,
  "passwordResetToken": null,
  "roleHierarchy": "SUCCESS",
  "userRoleHierarchy": [
    "ADMIN",
    "MEMBER",
    "DEVELOPER",
    "GUEST"
  ],
  "users": null
}