@itentialopensource/adapter-accedian_skylight

{ "swagger": "2.0", "host": "api.analytics.accedian.io", "info": { "title": "Skylight Analytics API documentation", "version": "2021.03.0", "contact": { "email": "the.team@accedian.com" }, "description": "Here is Skylight Analytics's API documentation.\n# Introduction\nThis API is documented in **Open API format v2**. You can download the full API spec above, and use it with\ncompatible code generators to generate the client stubs.\n# Quick setup\n(Almost) every endpoint require a [valid user authentication](/#tag/AuthService), so this is probably where you should start.\nDepending on the access rights associated with your account, some endpoints may not be authorized. When such restriction exists,\nthe API documentation will outline which acess rights are required to access or modify a given resource.\n## Authenticate to obtain an Authorized Token\nYou must optain an `Authorization Bearer` (for subsequent API calls) or a set-cookie, for browser related calls. Both \nof these can be obtained by the [auth/login](/#tag/AuthService) endpoint.\n```bash\ncurl -X POST \\\n https://tenant-url.npav.accedian.net/api/v1/auth/login \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'username=tenantUsername&password=tenantUserPassword'\n```\n> Pro-tip: Replace \"tenant-url\" by your tenant name\nThe response will contained an authorized header and a set-cookie header\n```bash\nHTTP/2 200\ncontent-type: application/vnd.api+json\ncontent-length: 208\nauthorization: Bearer MTUzNTAyNDg[...]\nset-cookie: skylight-aaa=MTUzNTAyNDg[...]\n{\n \"data\": {\n \"attributes\":{\n \"emailAddress\":\"tenantUsername\",\n \"isPasswordSet\":true,\n \"isRegisteredForEmail\":false,\n \"name\":\"tenantName\",\n \"roles\":[\"tenant-role\"],\n \"tenants\":[\"tenantName\"]},\n \"id\":\"1\",\n \"type\":\"users\"\n }\n}\n```\n## Making an authorized API request - (RAW metrics API query)\nOnce you have optained an `Authorization bearer` token, you can make a query to retrieve [RAW metrics](/#operation/GetRawMetrics). \n```bash\ncurl -X POST https://accedian-dh2.npav.accedian.net/api/v2/raw-metrics \\\n -d \"\\\n {'tenantId':'tenant12345',\\\n 'interval':'2018-08-08T11%3A12%3A53-04%3A00%2F2018-08-09T11%3A12%3A53-04%3A00',\\\n 'granularity':'PT78.545S',\\\n 'meta':{'colors':['orange']},\\\n 'timeout':30000,\\\n 'metrics':['jitterP95'],\\\n 'directions':['0','1','2'],\\\n 'objectType':'twamp-sf'\\\n }\" -H 'Cache-Control: no-cache' -H 'Authorization: MTUzNTAyNDg[...]'\n``` \n" }, "basePath": "/api", "schemes": [ "https" ], "consumes": [ "application/json", "application/vnd.api+json" ], "produces": [ "application/json", "application/vnd.api+json" ], "paths": { "/openid-configuration/{clientName}": { "get": { "operationId": "OpenIDConfiguration", "responses": { "200": { "description": "Returns the proxy configuration for the external OP", "schema": { "$ref": "#/definitions/OIDConfig" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "clientName", "in": "path", "required": true, "type": "string", "description": "The name of the openID provider we're trying to access" } ], "tags": [ "OpenID" ] } }, "/openid-token/{clientName}": { "post": { "operationId": "OpenIDToken", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "responses": { "200": { "description": "Returns the oidc token", "headers": { "Content-Type": { "type": "string", "default": "application/json" } }, "schema": { "$ref": "#/definitions/OIDToken" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "grant_type", "in": "formData", "required": true, "default": "authorization_code", "type": "string", "enum": [ "authorization_code" ] }, { "name": "code", "in": "formData", "required": true, "type": "string" }, { "name": "client_id", "in": "formData", "required": true, "type": "string" }, { "name": "client_secret", "in": "formData", "required": true, "type": "string" }, { "name": "clientName", "in": "path", "required": true, "type": "string", "description": "The name of the openID provider we're trying to access" } ], "tags": [ "OpenID" ] } }, "/openid-auth": { "get": { "operationId": "OpenIDAuth", "responses": { "302": { "description": "Redirects", "headers": { "Location": { "type": "string" } } } }, "parameters": [ { "name": "client_id", "in": "query", "description": "Our client ID which is registered in the OP", "required": true, "type": "string" }, { "name": "redirect_uri", "in": "query", "description": "URI of where the OP will redirect upon successful authentication", "required": true, "type": "string" }, { "name": "response_type", "in": "query", "description": "What we are requesting from the OP", "required": true, "type": "string", "default": "code" }, { "name": "state", "in": "query", "description": "Value that has to match between OIDC requests", "required": true, "type": "string" }, { "name": "delegatedclientid", "in": "query", "type": "string" }, { "name": "scope", "in": "query", "description": "scope of the OIDC request", "required": true, "type": "string", "default": "openid" } ], "tags": [ "OpenID" ] } }, "/saml-redirect": { "get": { "operationId": "SamlRedirect", "parameters": [ { "name": "clientName", "in": "query", "required": true, "type": "string", "description": "The name of the SAML client we'll be delegating auth to" } ], "responses": { "302": { "description": "Redirects", "headers": { "Location": { "type": "string" } } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "SAML" ] } }, "/saml-callback": { "post": { "operationId": "SamlCallback", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "parameters": [ { "name": "SAMLResponse", "in": "formData", "required": true, "type": "string" }, { "name": "RelayState", "in": "formData", "required": true, "type": "string" } ], "responses": { "302": { "description": "Redirects to login page", "headers": { "Location": { "type": "string" } } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "SAML" ] } }, "/saml-metadata/{clientName}": { "get": { "operationId": "SamlSpMetadata", "produces": [ "text/plain" ], "responses": { "200": { "description": "Returns the SAML service provider metadata ", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "clientName", "in": "path", "required": true, "type": "string", "description": "The name of the SAML provider we're trying to access" } ], "tags": [ "SAML" ] } }, "/v1/grant": { "post": { "summary": "Create a Granting Ticket used to obtain Service Tickets", "operationId": "CreateGrantingTicket", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "text/plain" ], "responses": { "201": { "description": "Returns the Granting Ticket URL", "schema": { "type": "string" } }, "401": { "description": "Unauthorized access attempt", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "username", "in": "formData", "description": "Unique identifier of the User requesting access", "required": true, "type": "string" }, { "name": "password", "in": "formData", "description": "Password for the username of the User requesting access", "required": true, "type": "string" }, { "name": "service", "in": "formData", "description": "URL of the granting service.", "required": true, "type": "string", "default": "https://cas.local/aastubs/", "enum": [ "https://cas.local/aastubs/" ] } ], "tags": [ "TicketService" ] } }, "/v1/service": { "post": { "summary": "Obtain a Service Ticket used to access a particular resource", "operationId": "CreateServiceTicket", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Returns the Service Ticket value", "schema": { "type": "string" } }, "404": { "description": "The Granting ticket was not found/is no longer valid", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "grantingTicket", "in": "formData", "description": "The URL Granting ticket used to obtain the Service Ticket", "required": true, "type": "string" }, { "name": "service", "in": "formData", "description": "URL of the granting service.", "required": true, "type": "string", "default": "https://cas.local/aastubs/", "enum": [ "https://cas.local/aastubs/" ] } ], "tags": [ "TicketService" ] } }, "/v1/validate": { "post": { "summary": "Validate a Service Ticket used to access a particular resource", "operationId": "ValidateServiceTicket", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "responses": { "200": { "description": "Returns the result of the Service Ticket validation", "schema": { "$ref": "#/definitions/ValidationResponse" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "ticket", "in": "query", "description": "The Service Ticket to be validated.", "required": true, "type": "string" }, { "name": "service", "in": "query", "description": "URL of the granting service.", "required": true, "type": "string", "default": "https://cas.local/aastubs/", "enum": [ "https://cas.local/aastubs/" ] }, { "name": "format", "in": "query", "description": "The format of the validation response body.", "required": true, "type": "string", "default": "JSON", "enum": [ "JSON" ] } ], "tags": [ "TicketService" ] } }, "/v1/auth/users": { "post": { "summary": "Create a new User in Skylight AAA", "operationId": "CreateUser", "consumes": [ "application/vnd.api+json" ], "produces": [ "application/vnd.api+json" ], "responses": { "201": { "description": "User was successfully created in Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "400": { "description": "Bad request", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "Tenat, user group or role not found", "schema": { "type": "string" } }, "409": { "description": "Attempt to provision a User that is already provisioned", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiAAAUser" } } ], "tags": [ "AuthService" ] }, "get": { "summary": "Retrieve a list of Users known to Skylight AAA", "operationId": "GetAllUsers", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns a list of known Users to Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUserList" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "No Users provisioned", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/auth/users/{userId}": { "put": { "summary": "Update an existing User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateUser", "consumes": [ "application/vnd.api+json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "Attempt to update user but the user does not exist", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User to be updated." } ], "tags": [ "AuthService" ] }, "patch": { "summary": "Update properties of an existing User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateUserProperties", "consumes": [ "application/vnd.api+json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "400": { "description": "Attempt to update user but there is something wrong with the request data", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "Attempt to update user but the user does not exist", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User to be updated." } ], "tags": [ "AuthService" ] }, "get": { "summary": "Retrieve a single User by its known Id.", "operationId": "GetUser", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns a known User to Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User to be returned." } ], "tags": [ "AuthService" ] }, "delete": { "summary": "Delete a single User by its known Id.", "operationId": "DeleteUser", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the now deleted User from Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User to be deleted." } ], "tags": [ "AuthService" ] } }, "/v1/auth/users/{userId}/password": { "patch": { "summary": "Reset a pasword for a User provisioned in Skylight AAA.", "operationId": "ResetPassword", "consumes": [ "application/json" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Returns the onboarding URL for the user", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User to reset the password." } ], "tags": [ "AuthService" ] } }, "/v1/auth/users/{userId}/email": { "patch": { "summary": "Change the email address of a User provisioned in Skylight AAA.", "operationId": "ChangeEmailAddress", "consumes": [ "application/json" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "The email address of the user has been changed", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The unique identifier of the User which is changing email address" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmailChangeRequest" } } ], "tags": [ "AuthService" ] } }, "/v1/auth/me": { "patch": { "summary": "Update properties of the currently authenticated User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateAuthenticatedUserProperties", "consumes": [ "application/vnd.api+json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "400": { "description": "Attempt to update user but there is something wrong with the request data", "schema": { "type": "string" } }, "401": { "description": "Attempt to update user but there is something wrong with the authentication parameters", "schema": { "type": "string" } }, "403": { "description": "Attempt to update user but operation is not allowed on resource", "schema": { "type": "string" } }, "404": { "description": "Attempt to update user but the user does not exist", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiAAAUser" } } ], "tags": [ "AuthService" ] }, "get": { "summary": "Retrieve the currently Authenticated User.", "operationId": "GetAuthenticatedUser", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the currently Authenticated User", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "401": { "description": "Attempt to fetch a user but there is something wrong with the authentication parameters", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] }, "delete": { "summary": "Delete the currently Authenticated User.", "operationId": "DeleteAuthenticatedUser", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the now deleted User from Skylight AAA", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "401": { "description": "Attempt to delete a user but there is something wrong with the authentication parameters", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/auth/me/password": { "patch": { "summary": "Updates the password of the currently Authenticated User.", "operationId": "UpdateAuthenticatedUserPassword", "consumes": [ "application/json" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Password was successfully updated", "schema": { "type": "string" } }, "400": { "description": "Attempt to update user but there is something wrong with the request data", "schema": { "type": "string" } }, "401": { "description": "Attempt to update user password but there is an error evaluating the authentication token", "schema": { "type": "string" } }, "404": { "description": "Attempt to update user but the user does not exist", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordChangeRequest" } } ], "tags": [ "AuthService" ] } }, "/v1/auth/me/email": { "patch": { "summary": "Change the email address of the currently Authenticated User.", "operationId": "ChangeAuthenticatedUserEmailAddress", "consumes": [ "application/json" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "The email address of the Authenticated User has been changed", "schema": { "type": "string" } }, "400": { "description": "Attempt to update user email address but there is something wrong with the request data", "schema": { "type": "string" } }, "401": { "description": "Attempt to update user email address but there is an error evaluating the authentication token", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmailChangeRequest" } } ], "tags": [ "AuthService" ] } }, "/v1/onboarding/{onboardingToken}": { "get": { "summary": "Retrieve the User mapped to the onboarding token.", "operationId": "GetUserByToken", "consumes": [ "application/json" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the User mapped to the onboarding token", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "onboardingToken", "in": "path", "required": true, "type": "string", "description": "The one-time use token provided to access the password set operation" } ], "tags": [ "AuthService" ] } }, "/v1/onboarding/password": { "post": { "summary": "Sets the password of a User that has had their password reset.", "operationId": "SetUserPassword", "consumes": [ "application/json" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "The password has been set", "schema": { "type": "string" } }, "400": { "description": "Attempt to update password, but the request has bad data", "schema": { "type": "string" } }, "404": { "description": "Attempt to update password, but the user no longer exists", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SetPasswordRequest" } } ], "tags": [ "AuthService" ] } }, "/v1/auth/login": { "post": { "summary": "Login a Skylight User", "operationId": "Login", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the Authenticated User", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "401": { "description": "Unauthorized access attempt", "schema": { "type": "string" } }, "404": { "description": "User not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "username", "in": "formData", "description": "Unique identifier of the User requesting access", "type": "string" }, { "name": "password", "in": "formData", "description": "Password for the username of the User requesting access", "type": "string" }, { "name": "token", "in": "formData", "description": "Signed JWT issues by Accedian. Can be used instead of username/password", "type": "string" } ], "tags": [ "AuthService" ] } }, "/v1/auth/logout": { "post": { "summary": "Logout a Skylight User", "operationId": "Logout", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Successfully logged out a Skylight User", "schema": { "type": "string" } }, "404": { "description": "Session not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/auth/session": { "get": { "summary": "Validate an active Skylight Session and return User data", "operationId": "Validate", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Returns the Authenticated User", "schema": { "$ref": "#/definitions/JsonApiAAAUser" } }, "401": { "description": "Session not Authorized", "schema": { "type": "string" } }, "403": { "description": "Session not Valid", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/auth/validate": { "get": { "summary": "Validate an active Skylight Session. Sets headers for proxy requests to have access to user data.", "operationId": "ValidateSessionForProxy", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Sets Headers X-Forwarded-User-Id, X-Forwarded-User-Username, X-Forwarded-Usergroups, and X-Forwarded-User-Roles which contain the Id, Username, and Role respectively of the User for the valid session", "schema": { "type": "string" }, "headers": { "X-Forwarded-User-Id": { "type": "string", "description": "Unique identifier of the User in Skylight AAA." }, "X-Forwarded-User-Username": { "type": "string", "description": "The Username of the User in Skylight-AAA." }, "X-Forwarded-User-Roles": { "type": "string", "description": "The Roles associated with this User in Skylight-AAA." }, "X-Forwarded-Usergroups": { "type": "string", "description": "The Usergroups associated with this User in Skylight-AAA." }, "X-Forwarded-Tenant-Id": { "type": "string", "description": "The TenantId associated with this request in Skylight-AAA." }, "X-Forwarded-JWT": { "type": "string", "description": "The JWT associated with the user session" } } }, "401": { "description": "Session not Authorized", "schema": { "type": "string" } }, "403": { "description": "Session not Valid", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/auth/service": { "post": { "summary": "Create a new Service in Skylight AAA. This function is only available to Skylight Admin users.", "operationId": "CreateService", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "text/plain" ], "responses": { "201": { "description": "Service was successfully created in Skylight AAA", "schema": { "type": "string" } }, "401": { "description": "User creating the Service is not Authorized to do so", "schema": { "type": "string" } }, "403": { "description": "User does not have authorization to perform this operation", "schema": { "type": "string" } }, "409": { "description": "Attempt to provision a Service that is already provisioned", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "serviceName", "in": "formData", "description": "Unique identifier of the Service to be added", "required": true, "type": "string" }, { "name": "username", "in": "formData", "description": "Username", "required": true, "type": "string" }, { "name": "password", "in": "formData", "description": "Password", "required": true, "type": "string" } ], "tags": [ "AuthService" ] } }, "/v1/onboarding/tenant-info": { "get": { "summary": "Retrieves the generic identifyiong information for a customer.", "operationId": "GetTenantInfo", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Successfully retrieved tenant info", "schema": { "$ref": "#/definitions/JsonApiTenantInfo" } }, "404": { "description": "No branding found for this tenant", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "tags": [ "AuthService" ] } }, "/v1/onboarding/tenant-identity": { "put": { "summary": "Adds tenant identifying information which is retreived in the 'onboarding/tenant-info' call. Operation is only available to Skylight Administrators.", "operationId": "SetTenantIdentity", "consumes": [ "application/vnd.api+json" ], "produces": [ "application/vnd.api+json" ], "responses": { "201": { "description": "Successfully updated tenant identifying information", "schema": { "$ref": "#/definitions/JsonApiTenantInfo" } }, "400": { "description": "The request data is not in the proper format", "schema": { "type": "string" } }, "401": { "description": "User is not authorized to perform this operation", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiTenantInfo" } } ], "tags": [ "AuthService" ] } }, "/v1/onboarding/tenant-identity/{subdomain}": { "delete": { "summary": "Deletes tenant identifying information. Operation is only available to Skylight Administrators.", "operationId": "DeleteTenantIdentity", "consumes": [ "text/plain" ], "produces": [ "application/vnd.api+json" ], "responses": { "200": { "description": "Successfully deleted tenant identifying information", "schema": { "$ref": "#/definitions/JsonApiTenantInfo" } }, "400": { "description": "The request data is not in the proper format", "schema": { "type": "string" } }, "401": { "description": "User is not authorized to perform this operation", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "404": { "description": "Tenant identity record not found", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "subdomain", "in": "path", "description": "Unique identifier of the Subdomain to delete the tenant mapping", "required": true, "type": "string" } ], "tags": [ "AuthService" ] } }, "/v1/auth/tokens": { "post": { "summary": "Create a new web token for authentication/authorization", "operationId": "CreateToken", "consumes": [ "application/vnd.api+json" ], "produces": [ "text/plain" ], "responses": { "201": { "description": "Token was successfully created in Skylight AAA", "schema": { "type": "string" } }, "403": { "description": "Requestor does not have permission to perform this action", "schema": { "type": "string" } }, "500": { "description": "Unexpected error processing request", "schema": { "type": "string" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/JsonApiJWT" } } ], "tags": [ "AuthService" ] }, "get": { "summary": "Retrieve a list of Tokens known to Skylight AAA", "operationId": "G