Versions Compared

Old Version 11

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

Available_since
Type Available Since
Release1.3.0
Excerpt

Defines the Login resource used to login to the SBC 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.

Info

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 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.

Note

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 LengthIdentifies 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 LengthIdentifies the password for the user that is being used to create a new session.