Users

Get all users

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users

HTTPcURLJavaScriptPython

GET /api/users HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "account_disabled": true,
    "auth_type": "text",
    "display_name": "text",
    "external_identity_provider_id": "text",
    "is_mfa_enabled": true,
    "isadmin": true,
    "issuperadmin": true,
    "last_login_time": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "num_access_tokens": 1,
    "platform_role_id": "super-admin",
    "remote_gw_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "user_group_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "username": "text"
  }
]

Get an individual user

get

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to fetch

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users/{username}

HTTPcURLJavaScriptPython

GET /api/users/{username} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Create a user

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to create

Body

application/json

account_disabledbooleanOptional

auth_typestringOptional

display_namestringOptional

external_identity_provider_idstringOptional

is_mfa_enabledbooleanOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

totp_secretstringOptional

usernamestring · min: 3Optional

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/users/{username}

HTTPcURLJavaScriptPython

POST /api/users/{username} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Update a user

put

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to update

Body

application/json

account_disabledbooleanOptional

auth_typestringOptional

display_namestringOptional

external_identity_provider_idstringOptional

is_mfa_enabledbooleanOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

totp_secretstringOptional

usernamestring · min: 3Optional

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

put

/api/users/{username}

HTTPcURLJavaScriptPython

PUT /api/users/{username} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Delete a user

delete

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to delete

Query parameters

force_delete_configsstringOptional

Force delete configs

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/api/users/{username}

HTTPcURLJavaScriptPython

DELETE /api/users/{username} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Disable a user's account

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to disable

Query parameters

force_disable_configsstringOptional

Force disable configs

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/disable

HTTPcURLJavaScriptPython

POST /api/users/{username}/disable HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Enable a user's account

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to enable

Query parameters

force_enable_configsstringOptional

Force enable configs

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/enable

HTTPcURLJavaScriptPython

POST /api/users/{username}/enable HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Get user remote access gateways

get

Authorizations

oauth

Path parameters

usernamestringRequired

Username to fetch all the gateways with access

Query parameters

device_idstringOptional

Device ID

remote_access_clientidstringOptional

Remote access client ID

from_mobilestringOptional

If 'true', returns array format

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users/{username}/remote_access_gw

HTTPcURLJavaScriptPython

GET /api/users/{username}/remote_access_gw HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Attach user to a remote access gateway

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username

remote_access_gateway_idstringRequired

Remote Access Gateway ID

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/remote_access_gw/{remote_access_gateway_id}

HTTPcURLJavaScriptPython

POST /api/users/{username}/remote_access_gw/{remote_access_gateway_id} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Remove user from a remote access gateway

delete

Authorizations

oauth

Path parameters

usernamestringRequired

Username

remote_access_gateway_idstringRequired

Remote Access Gateway ID

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/api/users/{username}/remote_access_gw/{remote_access_gateway_id}

HTTPcURLJavaScriptPython

DELETE /api/users/{username}/remote_access_gw/{remote_access_gateway_id} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Get a user's preferences and settings

get

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user

Responses

200

OK

application/json

get

/api/users/{username}/settings

HTTPcURLJavaScriptPython

GET /api/users/{username}/settings HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

OK

{
  "reduced_motion": true,
  "text_size": "text",
  "theme": "dark"
}

Update a user's preferences and settings

put

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user

Body

application/json

reduced_motionbooleanOptional

text_sizestringOptional

themestring · enumOptionalPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/users/{username}/settings

HTTPcURLJavaScriptPython

PUT /api/users/{username}/settings HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "reduced_motion": true,
  "text_size": "text",
  "theme": "dark"
}

{
  "reduced_motion": true,
  "text_size": "text",
  "theme": "dark"
}

Validate a user's identity

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username

Body

application/json

passwordstringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/users/{username}/validate-identity

HTTPcURLJavaScriptPython

POST /api/users/{username}/validate-identity HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

{
  "identity_validated": true
}

Create a super admin

post

Body

application/json

account_disabledbooleanOptional

auth_typestringOptional

display_namestringOptional

external_identity_provider_idstringOptional

is_mfa_enabledbooleanOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

totp_secretstringOptional

usernamestring · min: 3Optional

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/adm/createsuperadmin

HTTPcURLJavaScriptPython

POST /api/users/adm/createsuperadmin HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Check if the server has a super admin

get

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users/adm/hassuperadmin

HTTPcURLJavaScriptPython

GET /api/users/adm/hassuperadmin HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

true

Transfer super admin role to another admin user

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the user to transfer super admin role

Responses

200

OK

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/users/adm/transfersuperadmin/{username}

HTTPcURLJavaScriptPython

POST /api/users/adm/transfersuperadmin/{username} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

List users attached to a remote access gateway

get

Authorizations

oauth

Path parameters

ingress_idstringRequired

Ingress Gateway ID

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/api/users/ingress/{ingress_id}

HTTPcURLJavaScriptPython

GET /api/users/ingress/{ingress_id} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "network": "text",
    "node_id": "text",
    "users": [
      {
        "account_disabled": true,
        "auth_type": "text",
        "display_name": "text",
        "external_identity_provider_id": "text",
        "is_mfa_enabled": true,
        "isadmin": true,
        "issuperadmin": true,
        "last_login_time": "text",
        "network_roles": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        },
        "num_access_tokens": 1,
        "platform_role_id": "super-admin",
        "remote_gw_ids": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "user_group_ids": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "username": "text"
      }
    ]
  }
]

Get all pending users

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users_pending

HTTPcURLJavaScriptPython

GET /api/users_pending HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "account_disabled": true,
    "auth_type": "text",
    "display_name": "text",
    "external_identity_provider_id": "text",
    "is_mfa_enabled": true,
    "isadmin": true,
    "issuperadmin": true,
    "last_login_time": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "num_access_tokens": 1,
    "platform_role_id": "super-admin",
    "remote_gw_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "user_group_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "username": "text"
  }
]

Delete all pending users

delete

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/users_pending

HTTPcURLJavaScriptPython

DELETE /api/users_pending HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Approve a pending user

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the pending user to approve

Responses

200

OK

application/json

500

Internal Server Error

application/json

post

/api/users_pending/user/{username}

HTTPcURLJavaScriptPython

POST /api/users_pending/user/{username} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Delete a pending user

delete

Authorizations

oauth

Path parameters

usernamestringRequired

Username of the pending user to delete

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/users_pending/user/{username}

HTTPcURLJavaScriptPython

DELETE /api/users_pending/user/{username} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Get an individual user with role info

get

Authorizations

oauth

Query parameters

usernamestringRequired

Username

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users?username=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "num_access_tokens": 1,
  "platform_role": {
    "default": true,
    "deny_dashboard_access": true,
    "full_access": true,
    "global_level_access": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "create": true,
          "delete": true,
          "read": true,
          "self_only": true,
          "update": true,
          "vpn_access": true
        }
      }
    },
    "id": "super-admin",
    "meta_data": "text",
    "name": "text",
    "network_id": "all_networks",
    "network_level_access": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "create": true,
          "delete": true,
          "read": true,
          "self_only": true,
          "update": true,
          "vpn_access": true
        }
      }
    }
  },
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {
      "color_code": "text",
      "default": true,
      "external_identity_provider_id": "text",
      "id": "text",
      "meta_data": "text",
      "name": "text",
      "network_roles": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    }
  },
  "username": "text"
}

Get user access tokens

get

Authorizations

oauth

Query parameters

usernamestringRequired

Username

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/api/v1/users/access_token

HTTPcURLJavaScriptPython

GET /api/v1/users/access_token?username=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "created_at": "text",
    "created_by": "text",
    "expires_at": "text",
    "id": "text",
    "last_used": "text",
    "name": "text",
    "user_name": "text"
  }
]

Create a user API access token

post

Authorizations

oauth

Body

application/json

created_atstringOptional

created_bystringOptional

expires_atstringOptional

idstringOptional

last_usedstringOptional

namestringOptional

user_namestringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/v1/users/access_token

HTTPcURLJavaScriptPython

POST /api/v1/users/access_token HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "created_at": "text",
  "created_by": "text",
  "expires_at": "text",
  "id": "text",
  "last_used": "text",
  "name": "text",
  "user_name": "text"
}

{
  "authToken": "text",
  "userName": "text"
}

Delete user access tokens

delete

Authorizations

oauth

Query parameters

idstringRequired

Token ID

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete

/api/v1/users/access_token

HTTPcURLJavaScriptPython

DELETE /api/v1/users/access_token?id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Add user to network

put

Authorizations

oauth

Query parameters

usernamestringRequired

Username

network_idstringRequired

Network ID

Responses

200

OK

application/json

400

Bad Request

application/json

put

/api/v1/users/add_network_user

HTTPcURLJavaScriptPython

PUT /api/v1/users/add_network_user?username=text&network_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Get a user group

get

Authorizations

oauth

Query parameters

group_idstringRequired

Group ID

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/group

HTTPcURLJavaScriptPython

GET /api/v1/users/group?group_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "color_code": "text",
  "default": true,
  "external_identity_provider_id": "text",
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Create a user group

post

Authorizations

oauth

Body

application/json

membersstring[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/v1/users/group

HTTPcURLJavaScriptPython

POST /api/v1/users/group HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "members": [
    "text"
  ],
  "user_group": {
    "color_code": "text",
    "default": true,
    "external_identity_provider_id": "text",
    "id": "text",
    "meta_data": "text",
    "name": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  }
}

{
  "color_code": "text",
  "default": true,
  "external_identity_provider_id": "text",
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Update a user group

put

Authorizations

oauth

Body

application/json

color_codestringOptional

defaultbooleanOptional

external_identity_provider_idstringOptional

idstringOptional

meta_datastringOptional

namestringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/v1/users/group

HTTPcURLJavaScriptPython

PUT /api/v1/users/group HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "color_code": "text",
  "default": true,
  "external_identity_provider_id": "text",
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

{
  "color_code": "text",
  "default": true,
  "external_identity_provider_id": "text",
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Delete user group

delete

Authorizations

oauth

Query parameters

group_idstringRequired

Group ID required to delete the group

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/api/v1/users/group

HTTPcURLJavaScriptPython

DELETE /api/v1/users/group?group_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

List all user groups

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/groups

HTTPcURLJavaScriptPython

GET /api/v1/users/groups HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "color_code": "text",
    "default": true,
    "external_identity_provider_id": "text",
    "id": "text",
    "meta_data": "text",
    "name": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  }
]

Verify user invite

get

Query parameters

emailstringRequired

Invitee email

invite_codestringRequired

Invite code

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/invite

HTTPcURLJavaScriptPython

GET /api/v1/users/invite?email=text&invite_code=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Invite users

post

Authorizations

oauth

Body

application/json

platform_role_idstringOptional

user_emailsstring[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/users/invite

HTTPcURLJavaScriptPython

POST /api/v1/users/invite HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "platform_role_id": "text",
  "user_emails": [
    "text"
  ],
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "code": 1,
  "message": "text",
  "response": null
}

Delete a pending user invite

delete

Authorizations

oauth

Query parameters

invitee_emailstringRequired

Invitee email to delete

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/v1/users/invite

HTTPcURLJavaScriptPython

DELETE /api/v1/users/invite?invitee_email=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

User signup via invite

post

Query parameters

emailstringRequired

Invitee email

invite_codestringRequired

Invite code

Body

application/json

account_disabledbooleanOptional

auth_typestringOptional

display_namestringOptional

external_identity_provider_idstringOptional

is_mfa_enabledbooleanOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

totp_secretstringOptional

usernamestring · min: 3Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/users/invite-signup

HTTPcURLJavaScriptPython

POST /api/v1/users/invite-signup?email=text&invite_code=text HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "code": 1,
  "message": "text",
  "response": null
}

List all pending user invites

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/invites

HTTPcURLJavaScriptPython

GET /api/v1/users/invites HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "email": "text",
    "invite_code": "text",
    "invite_url": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "platform_role_id": "text",
    "user_group_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
]

Delete all pending user invites

delete

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/v1/users/invites

HTTPcURLJavaScriptPython

DELETE /api/v1/users/invites HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Log out a user

post

Authorizations

oauth

Query parameters

usernamestringRequired

Username

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/users/logout

HTTPcURLJavaScriptPython

POST /api/v1/users/logout?username=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

List users network IP mappings

get

Authorizations

oauth

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/api/v1/users/network_ip

HTTPcURLJavaScriptPython

GET /api/v1/users/network_ip HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "mappings": {
    "ANY_ADDITIONAL_PROPERTY": {
      "groups": [
        "text"
      ],
      "user": "text"
    }
  }
}

Remove user from network

put

Authorizations

oauth

Query parameters

usernamestringRequired

Username

network_idstringRequired

Network ID

Responses

200

OK

application/json

400

Bad Request

application/json

put

/api/v1/users/remove_network_user

HTTPcURLJavaScriptPython

PUT /api/v1/users/remove_network_user?username=text&network_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "account_disabled": true,
  "auth_type": "text",
  "display_name": "text",
  "external_identity_provider_id": "text",
  "is_mfa_enabled": true,
  "isadmin": true,
  "issuperadmin": true,
  "last_login_time": "text",
  "network_roles": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "password": "text",
  "platform_role_id": "super-admin",
  "remote_gw_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "totp_secret": "text",
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Get user role permission template

get

Authorizations

oauth

Query parameters

role_idstringRequired

Role ID required to get the role details

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/role

HTTPcURLJavaScriptPython

GET /api/v1/users/role?role_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "default": true,
  "deny_dashboard_access": true,
  "full_access": true,
  "global_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  },
  "id": "super-admin",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "network_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  }
}

Create user role permission template

post

Authorizations

oauth

Body

application/json

defaultbooleanOptional

deny_dashboard_accessbooleanOptional

full_accessbooleanOptional

idstring · enumOptionalPossible values:

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/v1/users/role

HTTPcURLJavaScriptPython

POST /api/v1/users/role HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 483

{
  "default": true,
  "deny_dashboard_access": true,
  "full_access": true,
  "global_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  },
  "id": "super-admin",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "network_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  }
}

{
  "default": true,
  "deny_dashboard_access": true,
  "full_access": true,
  "global_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  },
  "id": "super-admin",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "network_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  }
}

Update user role permission template

put

Authorizations

oauth

Body

application/json

defaultbooleanOptional

deny_dashboard_accessbooleanOptional

full_accessbooleanOptional

idstring · enumOptionalPossible values:

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/v1/users/role

HTTPcURLJavaScriptPython

PUT /api/v1/users/role HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 483

{
  "default": true,
  "deny_dashboard_access": true,
  "full_access": true,
  "global_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  },
  "id": "super-admin",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "network_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  }
}

{
  "default": true,
  "deny_dashboard_access": true,
  "full_access": true,
  "global_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  },
  "id": "super-admin",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "network_level_access": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "create": true,
        "delete": true,
        "read": true,
        "self_only": true,
        "update": true,
        "vpn_access": true
      }
    }
  }
}

Delete user role permission template

delete

Authorizations

oauth

Query parameters

role_idstringRequired

Role ID required to delete the role

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/api/v1/users/role

HTTPcURLJavaScriptPython

DELETE /api/v1/users/role?role_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

List all user roles

get

Authorizations

oauth

Query parameters

platformstringOptional

If true, lists platform roles. Otherwise, lists network roles.

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/users/roles

HTTPcURLJavaScriptPython

GET /api/v1/users/roles HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "default": true,
    "deny_dashboard_access": true,
    "full_access": true,
    "global_level_access": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "create": true,
          "delete": true,
          "read": true,
          "self_only": true,
          "update": true,
          "vpn_access": true
        }
      }
    },
    "id": "super-admin",
    "meta_data": "text",
    "name": "text",
    "network_id": "all_networks",
    "network_level_access": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "create": true,
          "delete": true,
          "read": true,
          "self_only": true,
          "update": true,
          "vpn_access": true
        }
      }
    }
  }
]

List unassigned network users

get

Authorizations

oauth

Query parameters

network_idstringRequired

Network ID

Responses

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/users/unassigned_network_users

HTTPcURLJavaScriptPython

GET /api/v1/users/unassigned_network_users?network_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "account_disabled": true,
    "auth_type": "text",
    "display_name": "text",
    "external_identity_provider_id": "text",
    "is_mfa_enabled": true,
    "isadmin": true,
    "issuperadmin": true,
    "last_login_time": "text",
    "network_roles": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "num_access_tokens": 1,
    "platform_role_id": "super-admin",
    "remote_gw_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "user_group_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "username": "text"
  }
]