Extreme Networks Logo
Documentation Powered by ReDoc

ExtremeLocation Authentication and Authorization APIs (1.0.0)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com

ExtremeLocation Authentication and Authorization APIs allow a user to programmatically authorize, authenticate, and register with the ExtremeLocation service.

ExtremeLocation User Documentation

Authentication and Authorization Resource

Retrieve user information

Returns a particular user profile.

query Parameters
username
required
string

User name of the user to be retrieved.

Responses

200

User details for Tenant

400

Bad Request

404

Error fetching user details

get /v1/user
https://manage.extremelocation.com/eloc-api/auth-service/v1/user

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "users":
    [
    ]
}

Create new user

Create new user.

Request Body schema: application/json

Details of new user to be created.

uid
string
organization
string
username
string
phone
string
address
string
userType
string
scope
Array of strings

Responses

200

New User created succesfully

400

Bad Request

404

Error creating new user

post /v1/user
https://manage.extremelocation.com/eloc-api/auth-service/v1/user

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "uid": "string",
  • "organization": "string",
  • "username": "string",
  • "phone": "string",
  • "address": "string",
  • "userType": "string",
  • "scope":
    [
    ]
}

Retrieve current API key

Returns the current API key of the user.

query Parameters
accnum
required
string

Account number of the user.

Responses

200

Current API key returned successfully.

400

Bad Request

404

Exception while returning current API key.

get /v1/user/apiKey
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/apiKey

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "string",
  • "createdAt": "2019-08-15T18:28:35Z",
  • "expiryTime": "2019-08-15T18:28:35Z"
}

Generate new API key

Generate a new API key for the user.

Request Body schema: application/json

Details of the user to generate API key.

userName
string
password
string
type
string
Enum: "ADMIN" "GUEST"
token
string
expiry
string
accountnumber
string
errorcode
integer <int32>
errormsg
string
licenses
Array of strings
vertical
string
verticalName
string

Responses

200

API key generated successfully

400

Bad Request

404

Exception while generating API key

post /v1/user/apiKey
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/apiKey

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userName": "string",
  • "password": "string",
  • "type": "ADMIN",
  • "token": "string",
  • "expiry": "string",
  • "accountnumber": "string",
  • "errorcode": 0,
  • "errormsg": "string",
  • "licenses":
    [
    ],
  • "vertical": "string",
  • "verticalName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "string",
  • "createdAt": "2019-08-15T18:28:35Z",
  • "expiryTime": "2019-08-15T18:28:35Z"
}

Retrieve expired API keys

Get the expired API keys of the user.

query Parameters
accnum
required
string

Account number of the user

Responses

200

Expired API keys returned successfully

400

Bad Request

404

Exception while returning user expired API keys

get /v1/user/apiKey/expired
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/apiKey/expired

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Authenticate user

Get login and token information, error messages etc. User needs to provide unique user name and password to log in. The required parameters are as follows.
userName : The unique username of the user which is their email address.
password : Password of the user.

Request Body schema: application/json

Contains user credentials.

userName
string
password
string
type
string
Enum: "ADMIN" "GUEST"
token
string
expiry
string
accountnumber
string
errorcode
integer <int32>
errormsg
string
licenses
Array of strings
vertical
string
verticalName
string

Responses

200

User authenticated successfully.

400

Bad Request

404

Error authenticating user.

post /v1/user/authenticate
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/authenticate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userName": "string",
  • "password": "string",
  • "type": "ADMIN",
  • "token": "string",
  • "expiry": "string",
  • "accountnumber": "string",
  • "errorcode": 0,
  • "errormsg": "string",
  • "licenses":
    [
    ],
  • "vertical": "string",
  • "verticalName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userName": "string",
  • "password": "string",
  • "type": "ADMIN",
  • "token": "string",
  • "expiry": "string",
  • "accountnumber": "string",
  • "errorcode": 0,
  • "errormsg": "string",
  • "licenses":
    [
    ],
  • "vertical": "string",
  • "verticalName": "string"
}

Authorize user

User can be authorized for permissions with this api call. * Token should be provided as mandatory parameter while calling this api.
* The required parameters are as follows.
* feature : This represents the feature of the user.
* permission : This represents the permission level.
* token : Unique key used for authentication to authorize user.

Request Body schema: application/json

Contains token and user permission level

feature
string
permission
string
token
string

Responses

200

Service is authorized for the user

400

Bad Request

404

User does not have required permissions

post /v1/user/authorize
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/authorize

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feature": "string",
  • "permission": "string",
  • "token": "string"
}

Update user password

User can change the password by providing old and new password along with token.
* The required parameters are as follows.
* userName : This represents the unique username of the user.
* password : This represents the current password for the user.
* newPassword : This represents the new password for the user.

path Parameters
username
required
string

Username of the user whose password is to be changed.

Request Body schema: application/json

Contains updated user details

userName
string
password
string
type
string
Enum: "ADMIN" "GUEST"
token
string
expiry
string
accountnumber
string
errorcode
integer <int32>
errormsg
string
licenses
Array of strings
vertical
string
verticalName
string
newPassword
string

Responses

200

User password changed successfully

400

Bad Request

404

Exception while changing the user details

put /v1/user/changePwd/{username}
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/changePwd/{username}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userName": "string",
  • "password": "string",
  • "type": "ADMIN",
  • "token": "string",
  • "expiry": "string",
  • "accountnumber": "string",
  • "errorcode": 0,
  • "errormsg": "string",
  • "licenses":
    [
    ],
  • "vertical": "string",
  • "verticalName": "string",
  • "newPassword": "string"
}

Reset user password

If the user needs to reset the password then they need to send the forgot password request to server

path Parameters
username
required
string

Username of the user whose password is to be reset.

Responses

200

User password reset successful.

400

Bad Request

404

Exception while resetting the user passsword.

put /v1/user/forgotPwd/{username}
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/forgotPwd/{username}

Log out from server

User can be logged out from server by sending this API call. User need to provide token parameter with received token.
* The required parameters are as follows.
* feature : This represents the feature of the user.
* permission : This represents the permission level.
* token : Unique key used for authentication to authorize user.

Request Body schema: application/json

Contains token and user permission level

feature
string
permission
string
token
string

Responses

200

User logged out successfully

400

Bad Request

404

Exception while logging out user

post /v1/user/logout
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/logout

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feature": "string",
  • "permission": "string",
  • "token": "string"
}

Retrieve user information by parsing token.

Send the token to get associated user information and other details can from server using this API. User needs to provide token parameter with server received TOKEN, permission as "0" and feature "LSense".
* The required parameters are as follows.
* feature : This represents the feature of the user.
* permission : This represents the permission level.
* token : Unique key used for authentication to authorize user.

Request Body schema: application/json

Contains token and user permission level

feature
string
permission
string
token
string

Responses

200

User token parsed successfully.

400

Bad Request

404

Error parsing the user token.

post /v1/user/parse/token
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/parse/token

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feature": "string",
  • "permission": "string",
  • "token": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "featurePermissions":
    [
    ],
  • "userName": "string",
  • "fullName": "string",
  • "newPassword": "string",
  • "tenantId": "string",
  • "salt": "string",
  • "lockAccount": false,
  • "resetPassword": false,
  • "inactivityTimeout": 0
}

Retrieve user details

Logged in user details can be fetched with this API.

query Parameters
username
required
string

User name for which profile details are required.

Responses

200

User details retrived successfully.

400

Bad Request

404

Error while retriving user details.

get /v1/user/profile
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/profile

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "organization": "string",
  • "phone": "string",
  • "address": "string",
  • "accountnumber": "string"
}

Update user details

User profile can be updated with this API.

path Parameters
username
required
string

User name of the user whose profile is to be updated.

Request Body schema: application/json

Contains updated user details

username
string
organization
string
phone
string
address
string
captchacode
string
vertical
string
verticalName
string

Responses

200

User profile updated successfully.

400

Bad Request

404

Exception while updating the user profile

put /v1/user/profile/{username}
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/profile/{username}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "organization": "string",
  • "phone": "string",
  • "address": "string",
  • "captchacode": "string",
  • "vertical": "string",
  • "verticalName": "string"
}

Register user for new tenant

New Tenant's user can be registered with this API by providing user email, verification code through captcha.

Request Body schema: application/json

User details to register.

username
string
organization
string
phone
string
address
string
captchacode
string
vertical
string
verticalName
string

Responses

200

User registered successfully

400

Bad Request

404

Invalid user credentials

post /v1/user/register
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/register

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "organization": "string",
  • "phone": "string",
  • "address": "string",
  • "captchacode": "string",
  • "vertical": "string",
  • "verticalName": "string"
}

Validate user credentials

Validate user name and password. The required parameters are as follows.
* userName : The unique username of the user which is their email address.
* password : Password of the user.

Request Body schema: application/json

Contains user authentication details

userName
string
password
string
type
string
Enum: "ADMIN" "GUEST"
token
string
expiry
string
accountnumber
string
errorcode
integer <int32>
errormsg
string
licenses
Array of strings
vertical
string
verticalName
string

Responses

200

User validated successfully

400

Bad Request

404

Invalid User name/Password

post /v1/user/validate
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/validate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userName": "string",
  • "password": "string",
  • "type": "ADMIN",
  • "token": "string",
  • "expiry": "string",
  • "accountnumber": "string",
  • "errorcode": 0,
  • "errormsg": "string",
  • "licenses":
    [
    ],
  • "vertical": "string",
  • "verticalName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "msg": "string",
  • "code": 0
}

Verify user

By providing TOKEN; user can be verified with this API. The required parameter is as follows.
* token : Unique key used in query string to perform the operation.

query Parameters
token
required
string

Unique token to identify user.

Responses

200

User verified successfully.

400

Bad Request

404

Unable to find user.

get /v1/user/verify
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/verify

Update user details by username

This API is used when existing user details needs to be updated.

path Parameters
username
required
string

Username of the user whose information needs to be updated.

Request Body schema: application/json

Contains user details which need to be updated

uid
string
organization
string
username
string
phone
string
address
string
userType
string
scope
Array of strings

Responses

200

User details updated successfully

400

Bad Request

404

Exception while updating user details

put /v1/user/{username}
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/{username}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "uid": "string",
  • "organization": "string",
  • "username": "string",
  • "phone": "string",
  • "address": "string",
  • "userType": "string",
  • "scope":
    [
    ]
}

Delete user

This API is used when user details needs to be deleted

path Parameters
username
required
string

Username of the user who needs to be deleted

Responses

200

User details deleted successfully

400

Bad Request

404

Error deleting user details

delete /v1/user/{username}
https://manage.extremelocation.com/eloc-api/auth-service/v1/user/{username}