Common Resources v1.0

Transcription

1 Common Resources v1.0 Copyright Riverbed Technology Inc Created Aug 10, 2018 at 0:08 PM

2 Contents Contents Resource: auth_info auth_info: get Resource: info info: get Resource: ping ping: get Resource: services services: get Resource: session_auth session_auth: login session_auth: logout 2 2

3 Resource: auth_info Information that may be necessary to properly authenticate to the device. "login_banner":, "specify_purpose": boolean, "supported_methods": [ ] auth_info auth_info.login_banner auth_info.specify_purpose auth_info.supported_methods <boolean> > Information that may be necessary to properly authenticate to the device. A free-form text that should be displayed to the user prior to logging in, ala /etc/issue on UNIX systems Indicates whether or not this device can make use of the purpose when logging in List of supported authentication methods auth_info.supported_methods[items] A supported authentication method Values: BASIC, COOKIE, OAUTH_2_0; auth_info: get GET Returns an auth_info data object. Resource: info Device Info "device_name":, "hw_version":, "mgmt_addresses": [ ], "model":, "serial":, "sw_version": info Device Info Required properties: [device_name, model, sw_version]; info.device_name Device name info.hw_version Device hardware version (if applicable) info.mgmt_addresses > IP addresses configured/assigned to the management interface(s) of this device. info.mgmt_addresses[items] One management IP address info.model Device model info.serial Device serial number (if applicable) info.sw_version Device software version

4 info: get GET Returns an info data object. Resource: ping Safe resource for determining if the system is running. ping Safe resource for determining if the system is running. ping: get GET Returns a ping data object. Resource: services Available services on this device [ "id":, "versions": [ ], <prop>: any ] services > services[items] One service Available services on this device services[items].id Service identifier / namespace services[items].versions > API versions supported services[items].versions[items] One service version services[items].<prop> <any> services: get GET Returns a services data object.

5 Resource: session_auth Authentication via session-based cookies session_auth Authentication via session-based cookies session_auth: login Log in and create a new session POST Request Body Provide a request body with the following structure: "password":, "purpose":, "username": session_auth.links.login.request Login details session_auth.links.login.request. password Password to log in with session_auth.links.login.request.purpose Reason for logging in session_auth.links.login.request. username Username to log in with On success, the server returns a response body with the following structure: Required properties: [username, password]; "session_id":, "session_key": session_auth.links.login.response session_auth.links.login.response. session_id session_auth.links.login.response. session_key Value to be used in a session cookie Key to be used in a session cookie Required properties: [session_key, session_id]; session_auth: logout POST Request Body Do not provide a request body. On success, the server does not provide any body in the responses.