Skip to end of metadata
Go to start of metadata

About this Resource

Defines the Login resource used to login to the SBC Edge REST API. This is the first request that needs to be made before you can access any of the other REST Resources on the SBC Edge system.

The user used for the REST sessions must be of the REST access level. This user must be created from the WebUI prior to using the REST API. The REST client must remember cookies that are returned from the SBC Edge system and supply those same cookies back to the REST gateway with Cookie: headers on subsequent requests. All requests will be authenticated against that session cookie. If a valid session cookie is not found, the REST client will recieve an HTTP 401 status code in the response.

The REST client cookie session expires after 10 minutes of inactivity

REST API Methods for this Resource

Resource Schema

Parameters

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
UsernameYesNostringnone256 - Max Length Identifies the user name that is being used to create a new session. This user must be created with the REST access level from the WebUI.
PasswordYesNostringnone128 - Max Length Identifies the password for the user that is being used to create a new session.