Users | Netmaker

Get an individual user

get

Path parameters

usernamestringRequired

Username of the user to fetch

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users/{username}

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

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Create a user

post

Path parameters

usernamestringRequired

Username of the user to create

Body

auth_typestringOptional

external_identity_provider_idstringOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

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}

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

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Update a user

put

Path parameters

usernamestringRequired

Username of the user to update

Body

auth_typestringOptional

external_identity_provider_idstringOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

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}

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

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Delete a user

delete

Path parameters

usernamestringRequired

Username of the user to delete

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/users/{username}

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

text

Get Users Remote Access Gw.

get

Path parameters

usernamestringRequired

Username to fetch all the gateways with access

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users/{username}/remote_access_gw

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

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "addresses": "text",
      "allowed_endpoints": [
        "text"
      ],
      "connected": true,
      "dns_address": "text",
      "gw_client": {
        "address": "text",
        "address6": "text",
        "allowed_ips": [
          "text"
        ],
        "clientid": "text",
        "country": "text",
        "deniednodeacls": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "device_name": "text",
        "dns": "text",
        "enabled": true,
        "extraallowedips": [
          "text"
        ],
        "ingressgatewayendpoint": "text",
        "ingressgatewayid": "text",
        "lastmodified": 1,
        "network": "text",
        "os": "text",
        "ownerid": "text",
        "postdown": "text",
        "postup": "text",
        "privatekey": "text",
        "public_endpoint": "text",
        "publickey": "text",
        "remote_access_client_id": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "gw_listen_port": 1,
      "gw_name": "text",
      "gw_peer_public_key": "text",
      "is_internet_gateway": true,
      "metadata": "text",
      "network": "text",
      "network_addresses": [
        "text"
      ],
      "remote_access_gw_id": "text",
      "status": "online"
    }
  ]
}

Create a super admin

post

Body

auth_typestringOptional

external_identity_provider_idstringOptional

isadminbooleanOptional

deprecated

issuperadminbooleanOptional

deprecated

last_login_timestringOptional

passwordstring · min: 5Required

platform_role_idstring · enumOptionalPossible values:

usernamestring · min: 3Optional

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/adm/createsuperadmin

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

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "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

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

true

Transfer super admin role to another admin user

post

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}

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

{
  "auth_type": "text",
  "external_identity_provider_id": "text",
  "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": {}
  },
  "user_group_ids": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "username": "text"
}

Get all pending users

get

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/users_pending

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

[
  {
    "auth_type": "text",
    "external_identity_provider_id": "text",
    "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": {}
    },
    "user_group_ids": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "username": "text"
  }
]

Delete all pending users

delete

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/users_pending

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

text

Approve a pending user

post

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}

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

text

Delete a pending user

delete

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}

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

text

Delete user group.

delete

Query parameters

group_idstringRequired

group id required to delete the role

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/v1/user/group

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

text

Get user role permission template.

get

Query parameters

role_idstringRequired

roleid required to get the role details

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/user/role

GET /api/v1/user/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

Body

defaultbooleanOptional

deny_dashboard_accessbooleanOptional

full_accessbooleanOptional

idstring · enumOptionalPossible values:

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

Responses

200

OK

application/json

500

Internal Server Error

application/json

post

/api/v1/user/role

POST /api/v1/user/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

Body

defaultbooleanOptional

deny_dashboard_accessbooleanOptional

full_accessbooleanOptional

idstring · enumOptionalPossible values:

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

Responses

200

OK

application/json

500

Internal Server Error

application/json

put

/api/v1/user/role

PUT /api/v1/user/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

Query parameters

role_idstringRequired

roleid required to delete the role

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/v1/user/role

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

text

lists all user roles.

get

Query parameters

role_idstringRequired

roleid required to get the role details

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/user/roles

GET /api/v1/user/roles?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
        }
      }
    }
  }
]

Good evening

hashtagGet an individual user

hashtagCreate a user

hashtagUpdate a user

hashtagDelete a user

hashtagGet Users Remote Access Gw.

hashtagCreate a super admin

hashtagCheck if the server has a super admin

hashtagTransfer super admin role to another admin user

hashtagGet all pending users

hashtagDelete all pending users

hashtagApprove a pending user

hashtagDelete a pending user

hashtagDelete user group.

hashtagGet user role permission template.

hashtagCreate user role permission template.

hashtagUpdate user role permission template.

hashtagDelete user role permission template.

hashtaglists all user roles.

Get an individual user

Create a user

Update a user

Delete a user

Get Users Remote Access Gw.

Create a super admin

Check if the server has a super admin

Transfer super admin role to another admin user

Get all pending users

Delete all pending users

Approve a pending user

Delete a pending user

Delete user group.

Get user role permission template.

Create user role permission template.

Update user role permission template.

Delete user role permission template.

lists all user roles.