UNPKG

@itentialopensource/adapter-accedian_skylight

Version:

This adapter integrates with system described as: accedianSkylight.

1,662 lines 1.04 MB
{ "openapi": "3.0.0", "info": { "title": "Skylight Analytics API documentation", "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", "contact": { "email": "the.team@accedian.com" }, "version": "2021.03.0" }, "servers": [ { "url": "https://api.analytics.accedian.io/api", "variables": {} } ], "paths": { "/openid-configuration/{clientName}": { "get": { "tags": [ "OpenID" ], "summary": "OpenIDConfiguration", "operationId": "OpenIDConfiguration", "parameters": [ { "name": "clientName", "in": "path", "description": "The name of the openID provider we're trying to access", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the proxy configuration for the external OP", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OIDConfig" } }, "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OIDConfig" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } }, "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/openid-token/{clientName}": { "post": { "tags": [ "OpenID" ], "summary": "OpenIDToken", "operationId": "OpenIDToken", "parameters": [ { "name": "clientName", "in": "path", "description": "The name of the openID provider we're trying to access", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string", "example": "application/x-www-form-urlencoded" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "required": [ "grant_type", "code", "client_id", "client_secret" ], "type": "object", "properties": { "grant_type": { "enum": [ "authorization_code" ], "type": "string", "example": "authorization_code" }, "code": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" } } } } }, "required": false }, "responses": { "200": { "description": "Returns the oidc token", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OIDToken" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/openid-auth": { "get": { "tags": [ "OpenID" ], "summary": "OpenIDAuth", "operationId": "OpenIDAuth", "parameters": [ { "name": "client_id", "in": "query", "description": "Our client ID which is registered in the OP", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "redirect_uri", "in": "query", "description": "URI of where the OP will redirect upon successful authentication", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "response_type", "in": "query", "description": "What we are requesting from the OP", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "code" } }, { "name": "state", "in": "query", "description": "Value that has to match between OIDC requests", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "delegatedclientid", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "scope of the OIDC request", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "openid" } } ], "responses": { "302": { "description": "Redirects", "headers": { "Location": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": {} } }, "deprecated": false } }, "/saml-redirect": { "get": { "tags": [ "SAML" ], "summary": "SamlRedirect", "operationId": "SamlRedirect", "parameters": [ { "name": "clientName", "in": "query", "description": "The name of the SAML client we'll be delegating auth to", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "302": { "description": "Redirects", "headers": { "Location": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": {} }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } }, "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/saml-callback": { "post": { "tags": [ "SAML" ], "summary": "SamlCallback", "operationId": "SamlCallback", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string", "example": "application/x-www-form-urlencoded" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "required": [ "SAMLResponse", "RelayState" ], "type": "object", "properties": { "SAMLResponse": { "type": "string" }, "RelayState": { "type": "string" } } } } }, "required": false }, "responses": { "302": { "description": "Redirects to login page", "headers": { "Location": { "content": { "text/plain": { "schema": { "type": "string" } } } } }, "content": {} }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/saml-metadata/{clientName}": { "get": { "tags": [ "SAML" ], "summary": "SamlSpMetadata", "operationId": "SamlSpMetadata", "parameters": [ { "name": "clientName", "in": "path", "description": "The name of the SAML provider we're trying to access", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the SAML service provider metadata", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/grant": { "post": { "tags": [ "TicketService" ], "summary": "CreateGrantingTicket", "description": "Create a Granting Ticket used to obtain Service Tickets", "operationId": "CreateGrantingTicket", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string", "example": "application/x-www-form-urlencoded" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "required": [ "username", "password", "service" ], "type": "object", "properties": { "username": { "type": "string", "description": "Unique identifier of the User requesting access" }, "password": { "type": "string", "description": "Password for the username of the User requesting access" }, "service": { "enum": [ "https://cas.local/aastubs/" ], "type": "string", "description": "URL of the granting service.", "example": "https://cas.local/aastubs/" } } } } }, "required": false }, "responses": { "201": { "description": "Returns the Granting Ticket URL", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access attempt", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/service": { "post": { "tags": [ "TicketService" ], "summary": "CreateServiceTicket", "description": "Obtain a Service Ticket used to access a particular resource", "operationId": "CreateServiceTicket", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string", "example": "application/x-www-form-urlencoded" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "required": [ "grantingTicket", "service" ], "type": "object", "properties": { "grantingTicket": { "type": "string", "description": "The URL Granting ticket used to obtain the Service Ticket" }, "service": { "enum": [ "https://cas.local/aastubs/" ], "type": "string", "description": "URL of the granting service.", "example": "https://cas.local/aastubs/" } } } } }, "required": false }, "responses": { "200": { "description": "Returns the Service Ticket value", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The Granting ticket was not found/is no longer valid", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/validate": { "post": { "tags": [ "TicketService" ], "summary": "ValidateServiceTicket", "description": "Validate a Service Ticket used to access a particular resource", "operationId": "ValidateServiceTicket", "parameters": [ { "name": "ticket", "in": "query", "description": "The Service Ticket to be validated.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "URL of the granting service.", "required": true, "style": "form", "explode": true, "schema": { "enum": [ "https://cas.local/aastubs/" ], "type": "string", "example": "https://cas.local/aastubs/" } }, { "name": "format", "in": "query", "description": "The format of the validation response body.", "required": true, "style": "form", "explode": true, "schema": { "enum": [ "JSON" ], "type": "string", "example": "JSON" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string", "example": "application/x-www-form-urlencoded" } } ], "responses": { "200": { "description": "Returns the result of the Service Ticket validation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResponse" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/users": { "post": { "tags": [ "AuthService" ], "summary": "CreateUser", "description": "Create a new User in Skylight AAA", "operationId": "CreateUser", "parameters": [], "requestBody": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } }, "required": true }, "responses": { "201": { "description": "User was successfully created in Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "400": { "description": "Bad request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "Tenat, user group or role not found", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "409": { "description": "Attempt to provision a User that is already provisioned", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "get": { "tags": [ "AuthService" ], "summary": "GetAllUsers", "description": "Retrieve a list of Users known to Skylight AAA", "operationId": "GetAllUsers", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns a list of known Users to Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUserList" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "No Users provisioned", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/users/{userId}": { "put": { "tags": [ "AuthService" ], "summary": "UpdateUser", "description": "Update an existing User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User to be updated.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } }, "required": true }, "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "Attempt to update user but the user does not exist", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "patch": { "tags": [ "AuthService" ], "summary": "UpdateUserProperties", "description": "Update properties of an existing User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateUserProperties", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User to be updated.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } }, "required": true }, "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "400": { "description": "Attempt to update user but there is something wrong with the request data", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "Attempt to update user but the user does not exist", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "get": { "tags": [ "AuthService" ], "summary": "GetUser", "description": "Retrieve a single User by its known Id.", "operationId": "GetUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User to be returned.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns a known User to Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "delete": { "tags": [ "AuthService" ], "summary": "DeleteUser", "description": "Delete a single User by its known Id.", "operationId": "DeleteUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User to be deleted.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns the now deleted User from Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/users/{userId}/password": { "patch": { "tags": [ "AuthService" ], "summary": "ResetPassword", "description": "Reset a pasword for a User provisioned in Skylight AAA.", "operationId": "ResetPassword", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User to reset the password.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns the onboarding URL for the user", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/users/{userId}/email": { "patch": { "tags": [ "AuthService" ], "summary": "ChangeEmailAddress", "description": "Change the email address of a User provisioned in Skylight AAA.", "operationId": "ChangeEmailAddress", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the User which is changing email address", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "The email address of the user has been changed", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Requestor does not have permission to perform this action", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/me": { "patch": { "tags": [ "AuthService" ], "summary": "UpdateAuthenticatedUserProperties", "description": "Update properties of the currently authenticated User in Skylight AAA. Does not update User email or Password.", "operationId": "UpdateAuthenticatedUserProperties", "parameters": [], "requestBody": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } }, "required": true }, "responses": { "200": { "description": "User was successfully updated in Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "400": { "description": "Attempt to update user but there is something wrong with the request data", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "401": { "description": "Attempt to update user but there is something wrong with the authentication parameters", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "403": { "description": "Attempt to update user but operation is not allowed on resource", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "Attempt to update user but the user does not exist", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "get": { "tags": [ "AuthService" ], "summary": "GetAuthenticatedUser", "description": "Retrieve the currently Authenticated User.", "operationId": "GetAuthenticatedUser", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns the currently Authenticated User", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "401": { "description": "Attempt to fetch a user but there is something wrong with the authentication parameters", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false }, "delete": { "tags": [ "AuthService" ], "summary": "DeleteAuthenticatedUser", "description": "Delete the currently Authenticated User.", "operationId": "DeleteAuthenticatedUser", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "Returns the now deleted User from Skylight AAA", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAAAUser" } } } }, "401": { "description": "Attempt to delete a user but there is something wrong with the authentication parameters", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } }, "500": { "description": "Unexpected error processing request", "headers": {}, "content": { "application/vnd.api+json": { "schema": { "type": "string" } } } } }, "deprecated": false } }, "/v1/auth/me/password": { "patch": { "tags": [ "AuthService" ], "summary": "UpdateAuthenticatedUserPassword", "description": "Updates the password of the currently Authenticated User.", "operationId": "UpdateAuthenticatedUserPassword", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "Password was successfully updated", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Attempt to update user but there is something wrong with the