Documentation Powered by ReDoc

Auth Service (3.1.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

This is the spec that defines the API provided by the application to provide auth across the cluster

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Auth

Validate Token

Validate if the input token is valid

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "message"
}

Create access token

Create an access token for EFA

Request Body schema: application/json

Credentials to fetch a token

username
string

Name of the user for whom the token has to be generated

password
string

Password for the above user

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token-type": "Bearer",
  • "refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "message": "Certificates will expire soon, please renew"
}

Create system access token

Create a system access token for EFA

Responses

Response samples

Content type
application/json
{
  • "access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token-type": "Bearer",
  • "refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "message": "Certificates will expire soon, please renew"
}

Create extended system access token

Create an extended system access token for EFA

Request Body schema: application/json

Credentials to fetch a token

clientId
string

ID of the registered client

expiry
integer

Number of seconds until extended token must expire

Responses

Request samples

Content type
application/json
{
  • "clientId": "sdjfdjskjd",
  • "expiry": 300
}

Response samples

Content type
application/json
{
  • "access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token-type": "Bearer",
  • "refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "message": "Certificates will expire soon, please renew"
}

Create access token for clients

Create an access token for XCO clients

Request Body schema: application/json

Client Credentials to fetch a token

username
string

Name of the user for whom the token has to be generated

password
string

Password for the above user

clientId
string

ID of the registered client

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token-type": "Bearer",
  • "message": "Certificates will expire soon, please renew"
}

Get access token with refresh token

Get access token with refresh token

Request Body schema: application/json

Refresh token

refresh-token
string

refresh token

grant-type
string

grant type(refresh_token)

Responses

Request samples

Content type
application/json
{
  • "grant-type": "refresh_token",
  • "refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token-type": "Bearer",
  • "refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "message": "Certificates will expire soon, please renew"
}

Get key for XCO client

Get API key for XCO client

Authorizations:
bearerAuth
query Parameters
clientId
required
string

Client ID

Responses