{ "id": "@itentialopensource/adapter-openstack_keystone", "type": "Adapter", "export": "OpenstackKeystone", "title": "Openstack_keystone", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "validateAndShowInformationForToken", "summary": "Validate and show information for token", "description": "Validate and show information for token", "input": [ { "name": "nocatalog", "type": "string", "info": "(Since v3.1) The authentication response excludes the service catalog. By default, the response includes the service catalog.: string", "required": false, "schema": { "title": "nocatalog", "type": "string" } }, { "name": "allowExpired", "type": "boolean", "info": "(Since v3.8) Allow fetching a token that has expired. By default expired tokens return a 404 exception.: boolean", "required": false, "schema": { "title": "allowExpired", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/validateAndShowInformationForToken" }, "task": true }, { "name": "checkToken", "summary": "Check token", "description": "Check token", "input": [ { "name": "allowExpired", "type": "boolean", "info": "(Since v3.8) Allow fetching a token that has expired. By default expired tokens return a 404 exception.: boolean", "required": false, "schema": { "title": "allowExpired", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkToken" }, "task": true }, { "name": "revokeToken", "summary": "Revoke token", "description": "Revoke token", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/revokeToken" }, "task": true }, { "name": "getServiceCatalog", "summary": "Get service catalog", "description": "Get service catalog", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getServiceCatalog" }, "task": true }, { "name": "getAvailableProjectScopes", "summary": "Get available project scopes", "description": "Get available project scopes", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAvailableProjectScopes" }, "task": true }, { "name": "getAvailableDomainScopes", "summary": "Get available domain scopes", "description": "Get available domain scopes", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAvailableDomainScopes" }, "task": true }, { "name": "getAvailableSystemScopes", "summary": "Get available system scopes", "description": "Get available system scopes", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAvailableSystemScopes" }, "task": true }, { "name": "createApplicationCredential", "summary": "Create application credential", "description": "Create application credential", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the application credential.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"application_credential\": {\"name\": \"string\", \"secret\": \"string\", \"description\": \"string\", \"expires_at\": \"string\", \"roles\": [{\"name\": \"string\"}], \"access_rules\": [{\"path\": \"string\", \"method\": \"string\", \"service\": \"string\"}], \"unrestricted\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "application_credential": { "type": "object", "properties": { "name": { "type": "string" }, "secret": { "type": "string" }, "description": { "type": "string" }, "expires_at": { "type": "string" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } } } }, "access_rules": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "method": { "type": "string" }, "service": { "type": "string" } } } }, "unrestricted": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createApplicationCredential" }, "task": true }, { "name": "listApplicationCredentials", "summary": "List application credentials", "description": "List application credentials", "input": [ { "name": "name", "type": "string", "info": "The name of the application credential. Must be unique to a user.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "userId", "type": "string", "info": "The ID of the user who owns the application credential.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listApplicationCredentials" }, "task": true }, { "name": "showApplicationCredentialDetails", "summary": "Show application credential details", "description": "Show application credential details", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the application credential.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "applicationCredentialId", "type": "string", "info": "The ID of the application credential.: string", "required": true, "schema": { "title": "applicationCredentialId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationCredentialDetails" }, "task": true }, { "name": "deleteApplicationCredential", "summary": "Delete application credential", "description": "Delete application credential", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the application credential.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "applicationCredentialId", "type": "string", "info": "The ID of the application credential.: string", "required": true, "schema": { "title": "applicationCredentialId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationCredential" }, "task": true }, { "name": "listAccessRules", "summary": "List access rules", "description": "List access rules", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the access rule.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAccessRules" }, "task": true }, { "name": "showAccessRuleDetails", "summary": "Show access rule details", "description": "Show access rule details", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the access rule.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "accessRuleId", "type": "string", "info": "The ID of the access rule.: string", "required": true, "schema": { "title": "accessRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRuleDetails" }, "task": true }, { "name": "deleteAccessRule", "summary": "Delete access rule", "description": "Delete access rule", "input": [ { "name": "userId", "type": "string", "info": "The ID of the user who owns the access rule.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "accessRuleId", "type": "string", "info": "The ID of the access rule.: string", "required": true, "schema": { "title": "accessRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessRule" }, "task": true }, { "name": "createCredential", "summary": "Create credential", "description": "Create credential", "input": [ { "name": "body", "type": "object", "info": ": {\"credential\": {\"blob\": \"string\", \"project_id\": \"string\", \"type\": \"string\", \"user_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "blob": { "type": "string" }, "project_id": { "type": "string" }, "type": { "type": "string" }, "user_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCredential" }, "task": true }, { "name": "listCredentials", "summary": "List credentials", "description": "List credentials", "input": [ { "name": "userId", "type": "string", "info": "Filters the response by a user ID.: string", "required": false, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listCredentials" }, "task": true }, { "name": "showCredentialDetails", "summary": "Show credential details", "description": "Show credential details", "input": [ { "name": "credentialId", "type": "string", "info": "The UUID for the credential.: string", "required": true, "schema": { "title": "credentialId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showCredentialDetails" }, "task": true }, { "name": "updateCredential", "summary": "Update credential", "description": "Update credential", "input": [ { "name": "credentialId", "type": "string", "info": "The UUID for the credential.: string", "required": true, "schema": { "title": "credentialId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"credential\": {\"blob\": \"string\", \"project_id\": \"string\", \"type\": \"string\", \"user_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "blob": { "type": "string" }, "project_id": { "type": "string" }, "type": { "type": "string" }, "user_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateCredential" }, "task": true }, { "name": "deleteCredential", "summary": "Delete credential", "description": "Delete credential", "input": [ { "name": "credentialId", "type": "string", "info": "The UUID for the credential.: string", "required": true, "schema": { "title": "credentialId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCredential" }, "task": true }, { "name": "listDomains", "summary": "List domains", "description": "List domains", "input": [ { "name": "name", "type": "string", "info": "Filters the response by a domain name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "enabled", "type": "string", "info": "If set to true, then only domains that are enabled will be returned, if set to false only that are disabled will be returned. Any value other than 0, including no value, ...(description truncated): string", "required": false, "schema": { "title": "enabled", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listDomains" }, "task": true }, { "name": "createDomain", "summary": "Create domain", "description": "Create domain", "input": [ { "name": "body", "type": "object", "info": ": {\"domain\": {\"description\": \"string\", \"enabled\": \"boolean\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "domain": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDomain" }, "task": true }, { "name": "showDomainDetails", "summary": "Show domain details", "description": "Show domain details", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainDetails" }, "task": true }, { "name": "updateDomain", "summary": "Update domain", "description": "Update domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"domain\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "domain": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDomain" }, "task": true }, { "name": "deleteDomain", "summary": "Delete domain", "description": "Delete domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomain" }, "task": true }, { "name": "showDefaultConfigurationSettings", "summary": "Show default configuration settings", "description": "Show default configuration settings", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/showDefaultConfigurationSettings" }, "task": true }, { "name": "showDefaultConfigurationForAGroup", "summary": "Show default configuration for a group", "description": "Show default configuration for a group", "input": [ { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDefaultConfigurationForAGroup" }, "task": true }, { "name": "showDefaultOptionForAGroup", "summary": "Show default option for a group", "description": "Show default option for a group", "input": [ { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } }, { "name": "option", "type": "string", "info": "The option name. For the ldap group, a valid value is url or user_tree_dn. For the identity group, a valid value is driver.: string", "required": true, "schema": { "title": "option", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDefaultOptionForAGroup" }, "task": true }, { "name": "showDomainGroupOptionConfiguration", "summary": "Show domain group option configuration", "description": "Show domain group option configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } }, { "name": "option", "type": "string", "info": "The option name. For the ldap group, a valid value is url or user_tree_dn. For the identity group, a valid value is driver.: string", "required": true, "schema": { "title": "option", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainGroupOptionConfiguration" }, "task": true }, { "name": "updateDomainGroupOptionConfiguration", "summary": "Update domain group option configuration", "description": "Update domain group option configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } }, { "name": "option", "type": "string", "info": "The option name. For the ldap group, a valid value is url or user_tree_dn. For the identity group, a valid value is driver.: string", "required": true, "schema": { "title": "option", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"url\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDomainGroupOptionConfiguration" }, "task": true }, { "name": "deleteDomainGroupOptionConfiguration", "summary": "Delete domain group option configuration", "description": "Delete domain group option configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } }, { "name": "option", "type": "string", "info": "The option name. For the ldap group, a valid value is url or user_tree_dn. For the identity group, a valid value is driver.: string", "required": true, "schema": { "title": "option", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomainGroupOptionConfiguration" }, "task": true }, { "name": "showDomainGroupConfiguration", "summary": "Show domain group configuration", "description": "Show domain group configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainGroupConfiguration" }, "task": true }, { "name": "updateDomainGroupConfiguration", "summary": "Update domain group configuration", "description": "Update domain group configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"config\": {\"ldap\": {\"url\": \"string\", \"user_tree_dn\": \"string\"}}}", "required": false, "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "ldap": { "type": "object", "properties": { "url": { "type": "string" }, "user_tree_dn": { "type": "string" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDomainGroupConfiguration" }, "task": true }, { "name": "deleteDomainGroupConfiguration", "summary": "Delete domain group configuration", "description": "Delete domain group configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "group", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "group", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomainGroupConfiguration" }, "task": true }, { "name": "createDomainConfiguration", "summary": "Create domain configuration", "description": "Create domain configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"config\": {\"identity\": {\"driver\": \"string\"}, \"ldap\": {\"url\": \"string\", \"user_tree_dn\": \"string\"}}}", "required": false, "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "identity": { "type": "object", "properties": { "driver": { "type": "string" } } }, "ldap": { "type": "object", "properties": { "url": { "type": "string" }, "user_tree_dn": { "type": "string" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDomainConfiguration" }, "task": true }, { "name": "showDomainConfiguration", "summary": "Show domain configuration", "description": "Show domain configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainConfiguration" }, "task": true }, { "name": "updateDomainConfiguration", "summary": "Update domain configuration", "description": "Update domain configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"config\": {\"ldap\": {\"url\": \"string\", \"user_tree_dn\": \"string\"}}}", "required": false, "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "ldap": { "type": "object", "properties": { "url": { "type": "string" }, "user_tree_dn": { "type": "string" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDomainConfiguration" }, "task": true }, { "name": "deleteDomainConfiguration", "summary": "Delete domain configuration", "description": "Delete domain configuration", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomainConfiguration" }, "task": true }, { "name": "listGroups", "summary": "List groups", "description": "List groups", "input": [ { "name": "name", "type": "string", "info": "Filters the response by a group name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "domainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listGroups" }, "task": true }, { "name": "createGroup", "summary": "Create group", "description": "Create group", "input": [ { "name": "body", "type": "object", "info": ": {\"group\": {\"description\": \"string\", \"domain_id\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "group": { "type": "object", "properties": { "description": { "type": "string" }, "domain_id": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createGroup" }, "task": true }, { "name": "showGroupDetails", "summary": "Show group details", "description": "Show group details", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupDetails" }, "task": true }, { "name": "updateGroup", "summary": "Update group", "description": "Update group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"group\": {\"description\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "group": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateGroup" }, "task": true }, { "name": "deleteGroup", "summary": "Delete group", "description": "Delete group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroup" }, "task": true }, { "name": "listUsersInGroup", "summary": "List users in group", "description": "List users in group", "input": [ { "name": "passwordExpiresAt", "type": "string", "info": "Filter results based on which user passwords have expired. The query should include an operator and a timestamp with a colon (:) separating the two, for example:: string", "required": false, "schema": { "title": "passwordExpiresAt", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listUsersInGroup" }, "task": true }, { "name": "addUserToGroup", "summary": "Add user to group", "description": "Add user to group", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addUserToGroup" }, "task": true }, { "name": "checkWhetherUserBelongsToGroup", "summary": "Check whether user belongs to group", "description": "Check whether user belongs to group", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkWhetherUserBelongsToGroup" }, "task": true }, { "name": "removeUserFromGroup", "summary": "Remove user from group", "description": "Remove user from group", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeUserFromGroup" }, "task": true }, { "name": "assignRoleToUserOnProjectsOwnedByDomain", "summary": "Assign role to user on projects owned by domain", "description": "Assign role to user on projects owned by domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToUserOnProjectsOwnedByDomain" }, "task": true }, { "name": "checkIfUserHasAnInheritedProjectRoleOnDomain", "summary": "Check if user has an inherited project role on domain", "description": "Check if user has an inherited project role on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkIfUserHasAnInheritedProjectRoleOnDomain" }, "task": true }, { "name": "revokeAnInheritedProjectRoleFromUserOnDomain", "summary": "Revoke an inherited project role from user on domain", "description": "Revoke an inherited project role from user on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeAnInheritedProjectRoleFromUserOnDomain" }, "task": true }, { "name": "assignRoleToGroupOnProjectsOwnedByADomain", "summary": "Assign role to group on projects owned by a domain", "description": "Assign role to group on projects owned by a domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToGroupOnProjectsOwnedByADomain" }, "task": true }, { "name": "checkIfGroupHasAnInheritedProjectRoleOnDomain", "summary": "Check if group has an inherited project role on domain", "description": "Check if group has an inherited project role on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkIfGroupHasAnInheritedProjectRoleOnDomain" }, "task": true }, { "name": "revokeAnInheritedProjectRoleFromGroupOnDomain", "summary": "Revoke an inherited project role from group on domain", "description": "Revoke an inherited project role from group on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeAnInheritedProjectRoleFromGroupOnDomain" }, "task": true }, { "name": "listUserSInheritedProjectRolesOnADomain", "summary": "List user’s inherited project roles on a domain", "description": "List user’s inherited project roles on a domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listUserSInheritedProjectRolesOnADomain" }, "task": true }, { "name": "listGroupSInheritedProjectRolesOnDomain", "summary": "List group’s inherited project roles on domain", "description": "List group’s inherited project roles on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listGroupSInheritedProjectRolesOnDomain" }, "task": true }, { "name": "assignRoleToUserOnProjectsInASubtree", "summary": "Assign role to user on projects in a subtree", "description": "Assign role to user on projects in a subtree", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToUserOnProjectsInASubtree" }, "task": true }, { "name": "checkIfUserHasAnInheritedProjectRoleOnProject", "summary": "Check if user has an inherited project role on project", "description": "Check if user has an inherited project role on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkIfUserHasAnInheritedProjectRoleOnProject" }, "task": true }, { "name": "revokeAnInheritedProjectRoleFromUserOnProject", "summary": "Revoke an inherited project role from user on project", "description": "Revoke an inherited project role from user on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeAnInheritedProjectRoleFromUserOnProject" }, "task": true }, { "name": "assignRoleToGroupOnProjectsInASubtree", "summary": "Assign role to group on projects in a subtree", "description": "Assign role to group on projects in a subtree", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToGroupOnProjectsInASubtree" }, "task": true }, { "name": "checkIfGroupHasAnInheritedProjectRoleOnProject", "summary": "Check if group has an inherited project role on project", "description": "Check if group has an inherited project role on project", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkIfGroupHasAnInheritedProjectRoleOnProject" }, "task": true }, { "name": "revokeAnInheritedProjectRoleFromGroupOnProject", "summary": "Revoke an inherited project role from group on project", "description": "Revoke an inherited project role from group on project", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeAnInheritedProjectRoleFromGroupOnProject" }, "task": true }, { "name": "listRoleAssignments", "summary": "List role assignments", "description": "List role assignments", "input": [ { "name": "effective", "type": "boolean", "info": "Returns the effective assignments, including any assignments gained by virtue of group membership.: boolean", "required": false, "schema": { "title": "effective", "type": "boolean" } }, { "name": "includeNames", "type": "boolean", "info": "If set to true, then the names of any entities returned will be include as well as their IDs. Any value other than 0 (including no value) will be interpreted as true.: boolean", "required": false, "schema": { "title": "includeNames", "type": "boolean" } }, { "name": "includeSubtree", "type": "boolean", "info": "If set to true, then relevant assignments in the project hierarchy below the project specified in the scope.project_id query parameter are also included in the response. ...(description truncated): boolean", "required": false, "schema": { "title": "includeSubtree", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "Filters the response by a group ID.: string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "Filters the response by a role ID.: string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "scopeDomainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "scopeDomainId", "type": "string" } }, { "name": "scopeOSINHERITInheritedTo", "type": "string", "info": "Filters based on role assignments that are inherited. The only value of inherited_to that is currently supported is projects.: string", "required": false, "schema": { "title": "scopeOSINHERITInheritedTo", "type": "string" } }, { "name": "scopeProjectId", "type": "string", "info": "Filters the response by a project ID.: string", "required": false, "schema": { "title": "scopeProjectId", "type": "string" } }, { "name": "userId", "type": "string", "info": "Filters the response by a user ID.: string", "required": false, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoleAssignments" }, "task": true }, { "name": "listRevokedTokens", "summary": "List revoked tokens", "description": "List revoked tokens", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listRevokedTokens" }, "task": true }, { "name": "createPolicy", "summary": "Create policy", "description": "Create policy", "input": [ { "name": "body", "type": "object", "info": ": {\"policy\": {\"blob\": \"string\", \"type\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "blob": { "type": "string" }, "type": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPolicy" }, "task": true }, { "name": "listPolicies", "summary": "List policies", "description": "List policies", "input": [ { "name": "type", "type": "string", "info": "Filters the response by a MIME media type for the serialized policy blob. For example, application/json.: string", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listPolicies" }, "task": true }, { "name": "showPolicyDetails", "summary": "Show policy details", "description": "Show policy details", "input": [ { "name": "policyId", "type": "string", "info": "The policy ID.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPolicyDetails" }, "task": true }, { "name": "updatePolicy", "summary": "Update policy", "description": "Update policy", "input": [ { "name": "policyId", "type": "string", "info": "The policy ID.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"policy\": {\"blob\": {\"foobar_user\": \"array\"}, \"type\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "blob": { "type": "object", "properties": { "foobar_user": { "type": "array", "items": { "type": "string" } } } }, "type": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePolicy" }, "task": true }, { "name": "deletePolicy", "summary": "Delete policy", "description": "Delete policy", "input": [ { "name": "policyId", "type": "string", "info": "The policy ID.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePolicy" }, "task": true }, { "name": "listProjects", "summary": "List projects", "description": "List projects", "input": [ { "name": "domainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "domainId", "type": "string" } }, { "name": "enabled", "type": "boolean", "info": "If set to true, then only enabled projects will be returned. Any value other than 0 (including no value) will be interpreted as true.: boolean", "required": false, "schema": { "title": "enabled", "type": "boolean" } }, { "name": "isDomain", "type": "boolean", "info": "If this is specified as true, then only projects acting as a domain are included. Otherwise, only projects that are not acting as a domain are included.: boolean", "required": false, "schema": { "title": "isDomain", "type": "boolean" } }, { "name": "name", "type": "string", "info": "Filters the response by a project name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "parentId", "type": "string", "info": "Filters the response by a parent ID.: string", "required": false, "schema": { "title": "parentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listProjects" }, "task": true }, { "name": "createProject", "summary": "Create project", "description": "Create project", "input": [ { "name": "body", "type": "object", "info": ": {\"project\": {\"description\": \"string\", \"domain_id\": \"string\", \"enabled\": \"boolean\", \"is_domain\": \"boolean\", \"name\": \"string\", \"options\": \"object\"}}", "required": false, "schema": { "type": "object", "properties": { "project": { "type": "object", "properties": { "description": { "type": "string" }, "domain_id": { "type": "string" }, "enabled": { "type": "boolean" }, "is_domain": { "type": "boolean" }, "name": { "type": "string" }, "options": { "type": "object" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createProject" }, "task": true }, { "name": "showProjectDetails", "summary": "Show project details", "description": "Show project details", "input": [ { "name": "parentsAsList", "type": "boolean", "info": "The parent hierarchy will be included as a list in the response. This list will contain the projects found by traversing up the hierarchy to the top-level project. The re...(description truncated): boolean", "required": false, "schema": { "title": "parentsAsList", "type": "boolean" } }, { "name": "subtreeAsList", "type": "boolean", "info": "The child hierarchy will be included as a list in the response. This list will contain the projects found by traversing down the hierarchy. The returned list will be filt...(description truncated): boolean", "required": false, "schema": { "title": "subtreeAsList", "type": "boolean" } }, { "name": "parentsAsIds", "type": "boolean", "info": "The entire parent hierarchy will be included as nested dictionaries in the response. It will contain all projects ids found by traversing up the hierarchy to the top-leve...(description truncated): boolean", "required": false, "schema": { "title": "parentsAsIds", "type": "boolean" } }, { "name": "subtreeAsIds", "type": "boolean", "info": "The entire child hierarchy will be included as nested dictionaries in the response. It will contain all the projects ids found by traversing down the hierarchy.: boolean", "required": false, "schema": { "title": "subtreeAsIds", "type": "boolean" } }, { "name": "includeLimits", "type": "boolean", "info": "It should be used together with parents_as_list or subtree_as_list filter to add the related project’s limits into the response body.: boolean", "required": false, "schema": { "title": "includeLimits", "type": "boolean" } }, { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showProjectDetails" }, "task": true }, { "name": "updateProject", "summary": "Update project", "description": "Update project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"project\": {\"description\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "project": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateProject" }, "task": true }, { "name": "deleteProject", "summary": "Delete project", "description": "Delete project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteProject" }, "task": true }, { "name": "listTagsForAProject", "summary": "List tags for a project", "description": "List tags for a project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listTagsForAProject" }, "task": true }, { "name": "modifyTagListForAProject", "summary": "Modify tag list for a project", "description": "Modify tag list for a project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"tags\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyTagListForAProject" }, "task": true }, { "name": "removeAllTagsFromAProject", "summary": "Remove all tags from a project", "description": "Remove all tags from a project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeAllTagsFromAProject" }, "task": true }, { "name": "checkIfProjectContainsTag", "summary": "Check if project contains tag", "description": "Check if project contains tag", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "tag", "type": "string", "info": "A simple string associated with a project. Can be used for assigning values to projects and filtering based on those values.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkIfProjectContainsTag" }, "task": true }, { "name": "addSingleTagToAProject", "summary": "Add single tag to a project", "description": "Add single tag to a project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "tag", "type": "string", "info": "A simple string associated with a project. Can be used for assigning values to projects and filtering based on those values.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSingleTagToAProject" }, "task": true }, { "name": "deleteSingleTagFromProject", "summary": "Delete single tag from project", "description": "Delete single tag from project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "tag", "type": "string", "info": "A simple string associated with a project. Can be used for assigning values to projects and filtering based on those values.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSingleTagFromProject" }, "task": true }, { "name": "showRegionDetails", "summary": "Show region details", "description": "Show region details", "input": [ { "name": "regionId", "type": "string", "info": "The region ID.: string", "required": true, "schema": { "title": "regionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRegionDetails" }, "task": true }, { "name": "updateRegion", "summary": "Update region", "description": "Update region", "input": [ { "name": "regionId", "type": "string", "info": "The region ID.: string", "required": true, "schema": { "title": "regionId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"region\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "region": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRegion" }, "task": true }, { "name": "deleteRegion", "summary": "Delete region", "description": "Delete region", "input": [ { "name": "regionId", "type": "string", "info": "The region ID.: string", "required": true, "schema": { "title": "regionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRegion" }, "task": true }, { "name": "listRegions", "summary": "List regions", "description": "List regions", "input": [ { "name": "parentRegionId", "type": "string", "info": "Filters the response by a parent region, by ID.: string", "required": false, "schema": { "title": "parentRegionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRegions" }, "task": true }, { "name": "createRegion", "summary": "Create region", "description": "Create region", "input": [ { "name": "body", "type": "object", "info": ": {\"region\": {\"description\": \"string\", \"id\": \"string\", \"parent_region_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "region": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "parent_region_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRegion" }, "task": true }, { "name": "listRoles", "summary": "List roles", "description": "List roles", "input": [ { "name": "name", "type": "string", "info": "Filters the response by a role name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "domainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoles" }, "task": true }, { "name": "createRole", "summary": "Create role", "description": "Create role", "input": [ { "name": "body", "type": "object", "info": ": {\"role\": {\"description\": \"string\", \"domain_id\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "role": { "type": "object", "properties": { "description": { "type": "string" }, "domain_id": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRole" }, "task": true }, { "name": "showRoleDetails", "summary": "Show role details", "description": "Show role details", "input": [ { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRoleDetails" }, "task": true }, { "name": "updateRole", "summary": "Update role", "description": "Update role", "input": [ { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"role\": {\"description\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "role": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRole" }, "task": true }, { "name": "deleteRole", "summary": "Delete role", "description": "Delete role", "input": [ { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRole" }, "task": true }, { "name": "listRoleAssignmentsForGroupOnDomain", "summary": "List role assignments for group on domain", "description": "List role assignments for group on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoleAssignmentsForGroupOnDomain" }, "task": true }, { "name": "assignRoleToGroupOnDomain", "summary": "Assign role to group on domain", "description": "Assign role to group on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToGroupOnDomain" }, "task": true }, { "name": "checkWhetherGroupHasRoleAssignmentOnDomain", "summary": "Check whether group has role assignment on domain", "description": "Check whether group has role assignment on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkWhetherGroupHasRoleAssignmentOnDomain" }, "task": true }, { "name": "unassignRoleFromGroupOnDomain", "summary": "Unassign role from group on domain", "description": "Unassign role from group on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignRoleFromGroupOnDomain" }, "task": true }, { "name": "listRoleAssignmentsForUserOnDomain", "summary": "List role assignments for user on domain", "description": "List role assignments for user on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoleAssignmentsForUserOnDomain" }, "task": true }, { "name": "assignRoleToUserOnDomain", "summary": "Assign role to user on domain", "description": "Assign role to user on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToUserOnDomain" }, "task": true }, { "name": "checkWhetherUserHasRoleAssignmentOnDomain", "summary": "Check whether user has role assignment on domain", "description": "Check whether user has role assignment on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkWhetherUserHasRoleAssignmentOnDomain" }, "task": true }, { "name": "unassignsRoleFromUserOnDomain", "summary": "Unassigns role from user on domain", "description": "Unassigns role from user on domain", "input": [ { "name": "domainId", "type": "string", "info": "The domain ID.: string", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignsRoleFromUserOnDomain" }, "task": true }, { "name": "listRoleAssignmentsForGroupOnProject", "summary": "List role assignments for group on project", "description": "List role assignments for group on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoleAssignmentsForGroupOnProject" }, "task": true }, { "name": "assignRoleToGroupOnProject", "summary": "Assign role to group on project", "description": "Assign role to group on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToGroupOnProject" }, "task": true }, { "name": "checkWhetherGroupHasRoleAssignmentOnProject", "summary": "Check whether group has role assignment on project", "description": "Check whether group has role assignment on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkWhetherGroupHasRoleAssignmentOnProject" }, "task": true }, { "name": "unassignRoleFromGroupOnProject", "summary": "Unassign role from group on project", "description": "Unassign role from group on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignRoleFromGroupOnProject" }, "task": true }, { "name": "listRoleAssignmentsForUserOnProject", "summary": "List role assignments for user on project", "description": "List role assignments for user on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoleAssignmentsForUserOnProject" }, "task": true }, { "name": "assignRoleToUserOnProject", "summary": "Assign role to user on project", "description": "Assign role to user on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignRoleToUserOnProject" }, "task": true }, { "name": "checkWhetherUserHasRoleAssignmentOnProject", "summary": "Check whether user has role assignment on project", "description": "Check whether user has role assignment on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkWhetherUserHasRoleAssignmentOnProject" }, "task": true }, { "name": "unassignRoleFromUserOnProject", "summary": "Unassign role from user on project", "description": "Unassign role from user on project", "input": [ { "name": "projectId", "type": "string", "info": "The project ID.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignRoleFromUserOnProject" }, "task": true }, { "name": "listImpliedInferenceRolesForRole", "summary": "List implied (inference) roles for role", "description": "List implied (inference) roles for role", "input": [ { "name": "priorRoleId", "type": "string", "info": "Role ID for a prior role.: string", "required": true, "schema": { "title": "priorRoleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listImpliedInferenceRolesForRole" }, "task": true }, { "name": "createRoleInferenceRule", "summary": "Create role inference rule", "description": "Create role inference rule", "input": [ { "name": "priorRoleId", "type": "string", "info": "Role ID for a prior role.: string", "required": true, "schema": { "title": "priorRoleId", "type": "string" } }, { "name": "impliesRoleId", "type": "string", "info": "Role ID for an implied role.: string", "required": true, "schema": { "title": "impliesRoleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRoleInferenceRule" }, "task": true }, { "name": "getRoleInferenceRule", "summary": "Get role inference rule", "description": "Get role inference rule", "input": [ { "name": "priorRoleId", "type": "string", "info": "Role ID for a prior role.: string", "required": true, "schema": { "title": "priorRoleId", "type": "string" } }, { "name": "impliesRoleId", "type": "string", "info": "Role ID for an implied role.: string", "required": true, "schema": { "title": "impliesRoleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRoleInferenceRule" }, "task": true }, { "name": "confirmRoleInferenceRule", "summary": "Confirm role inference rule", "description": "Confirm role inference rule", "input": [ { "name": "priorRoleId", "type": "string", "info": "Role ID for a prior role.: string", "required": true, "schema": { "title": "priorRoleId", "type": "string" } }, { "name": "impliesRoleId", "type": "string", "info": "Role ID for an implied role.: string", "required": true, "schema": { "title": "impliesRoleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/confirmRoleInferenceRule" }, "task": true }, { "name": "deleteRoleInferenceRule", "summary": "Delete role inference rule", "description": "Delete role inference rule", "input": [ { "name": "priorRoleId", "type": "string", "info": "Role ID for a prior role.: string", "required": true, "schema": { "title": "priorRoleId", "type": "string" } }, { "name": "impliesRoleId", "type": "string", "info": "Role ID for an implied role.: string", "required": true, "schema": { "title": "impliesRoleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRoleInferenceRule" }, "task": true }, { "name": "listAllRoleInferenceRules", "summary": "List all role inference rules", "description": "List all role inference rules", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listAllRoleInferenceRules" }, "task": true }, { "name": "listSystemRoleAssignmentsForAUser", "summary": "List system role assignments for a user", "description": "List system role assignments for a user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSystemRoleAssignmentsForAUser" }, "task": true }, { "name": "assignASystemRoleToAUser", "summary": "Assign a system role to a user", "description": "Assign a system role to a user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignASystemRoleToAUser" }, "task": true }, { "name": "checkUserForASystemRoleAssignment", "summary": "Check user for a system role assignment", "description": "Check user for a system role assignment", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkUserForASystemRoleAssignment" }, "task": true }, { "name": "getSystemRoleAssignmentForAUser", "summary": "Get system role assignment for a user", "description": "Get system role assignment for a user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSystemRoleAssignmentForAUser" }, "task": true }, { "name": "deleteASystemRoleAssignmentFromAUser", "summary": "Delete a system role assignment from a user", "description": "Delete a system role assignment from a user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteASystemRoleAssignmentFromAUser" }, "task": true }, { "name": "listSystemRoleAssignmentsForAGroup", "summary": "List system role assignments for a group", "description": "List system role assignments for a group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSystemRoleAssignmentsForAGroup" }, "task": true }, { "name": "assignASystemRoleToAGroup", "summary": "Assign a system role to a group", "description": "Assign a system role to a group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignASystemRoleToAGroup" }, "task": true }, { "name": "checkGroupForASystemRoleAssignment", "summary": "Check group for a system role assignment", "description": "Check group for a system role assignment", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkGroupForASystemRoleAssignment" }, "task": true }, { "name": "getSystemRoleAssignmentForAGroup", "summary": "Get system role assignment for a group", "description": "Get system role assignment for a group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSystemRoleAssignmentForAGroup" }, "task": true }, { "name": "deleteASystemRoleAssignmentFromAGroup", "summary": "Delete a system role assignment from a group", "description": "Delete a system role assignment from a group", "input": [ { "name": "groupId", "type": "string", "info": "The group ID.: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "roleId", "type": "string", "info": "The role ID.: string", "required": true, "schema": { "title": "roleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteASystemRoleAssignmentFromAGroup" }, "task": true }, { "name": "listServices", "summary": "List services", "description": "List services", "input": [ { "name": "name", "type": "string", "info": "Filters the response by a service name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": "Filters the response by a service type. A valid value is compute, ec2, identity, image, network, or volume.: string", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listServices" }, "task": true }, { "name": "createService", "summary": "Create service", "description": "Create service", "input": [ { "name": "body", "type": "object", "info": ": {\"service\": {\"type\": \"string\", \"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "service": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createService" }, "task": true }, { "name": "showServiceDetails", "summary": "Show service details", "description": "Show service details", "input": [ { "name": "serviceId", "type": "string", "info": "The service ID.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceDetails" }, "task": true }, { "name": "updateService", "summary": "Update service", "description": "Update service", "input": [ { "name": "serviceId", "type": "string", "info": "The service ID.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"service\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "service": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateService" }, "task": true }, { "name": "deleteService", "summary": "Delete service", "description": "Delete service", "input": [ { "name": "serviceId", "type": "string", "info": "The service ID.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteService" }, "task": true }, { "name": "listEndpoints", "summary": "List endpoints", "description": "List endpoints", "input": [ { "name": "interfaceParam", "type": "string", "info": "Filters the response by an interface.: string", "required": false, "schema": { "title": "interfaceParam", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "Filters the response by a service ID.: string", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "regionId", "type": "string", "info": "Filters the response by a region ID.: string", "required": false, "schema": { "title": "regionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listEndpoints" }, "task": true }, { "name": "createEndpoint", "summary": "Create endpoint", "description": "Create endpoint", "input": [ { "name": "body", "type": "object", "info": ": {\"endpoint\": {\"interface\": \"string\", \"region_id\": \"string\", \"url\": \"string\", \"service_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "interface": { "type": "string" }, "region_id": { "type": "string" }, "url": { "type": "string" }, "service_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createEndpoint" }, "task": true }, { "name": "showEndpointDetails", "summary": "Show endpoint details", "description": "Show endpoint details", "input": [ { "name": "endpointId", "type": "string", "info": "The endpoint ID.: string", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showEndpointDetails" }, "task": true }, { "name": "updateEndpoint", "summary": "Update endpoint", "description": "Update endpoint", "input": [ { "name": "endpointId", "type": "string", "info": "The endpoint ID.: string", "required": true, "schema": { "title": "endpointId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"endpoint\": {\"interface\": \"string\", \"region_id\": \"string\", \"url\": \"string\", \"service_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "interface": { "type": "string" }, "region_id": { "type": "string" }, "url": { "type": "string" }, "service_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateEndpoint" }, "task": true }, { "name": "deleteEndpoint", "summary": "Delete endpoint", "description": "Delete endpoint", "input": [ { "name": "endpointId", "type": "string", "info": "The endpoint ID.: string", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteEndpoint" }, "task": true }, { "name": "listRegisteredLimits", "summary": "List Registered Limits", "description": "List Registered Limits", "input": [ { "name": "serviceId", "type": "string", "info": "Filters the response by a service ID.: string", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "regionId", "type": "string", "info": "Filters the response by a region ID.: string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "resourceName", "type": "string", "info": "Filters the response by a specified resource name.: string", "required": false, "schema": { "title": "resourceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRegisteredLimits" }, "task": true }, { "name": "createRegisteredLimits", "summary": "Create Registered Limits", "description": "Create Registered Limits", "input": [ { "name": "body", "type": "object", "info": ": {\"registered_limits\": [{\"service_id\": \"string\", \"region_id\": \"string\", \"resource_name\": \"string\", \"default_limit\": 123, \"description\": \"string\"}]}", "required": false, "schema": { "type": "object", "properties": { "registered_limits": { "type": "array", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "region_id": { "type": "string" }, "resource_name": { "type": "string" }, "default_limit": { "type": "integer" }, "description": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRegisteredLimits" }, "task": true }, { "name": "updateRegisteredLimit", "summary": "Update Registered Limit", "description": "Update Registered Limit", "input": [ { "name": "registeredLimitId", "type": "string", "info": "The registered limit ID.: string", "required": true, "schema": { "title": "registeredLimitId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"registered_limit\": {\"service_id\": \"string\", \"region_id\": \"string\", \"resource_name\": \"string\", \"default_limit\": 123, \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "registered_limit": { "type": "object", "properties": { "service_id": { "type": "string" }, "region_id": { "type": "string" }, "resource_name": { "type": "string" }, "default_limit": { "type": "integer" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRegisteredLimit" }, "task": true }, { "name": "showRegisteredLimitDetails", "summary": "Show Registered Limit Details", "description": "Show Registered Limit Details", "input": [ { "name": "registeredLimitId", "type": "string", "info": "The registered limit ID.: string", "required": true, "schema": { "title": "registeredLimitId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRegisteredLimitDetails" }, "task": true }, { "name": "deleteRegisteredLimit", "summary": "Delete Registered Limit", "description": "Delete Registered Limit", "input": [ { "name": "registeredLimitId", "type": "string", "info": "The registered limit ID.: string", "required": true, "schema": { "title": "registeredLimitId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRegisteredLimit" }, "task": true }, { "name": "getEnforcementModel", "summary": "Get Enforcement Model", "description": "Get Enforcement Model", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getEnforcementModel" }, "task": true }, { "name": "listLimits", "summary": "List Limits", "description": "List Limits", "input": [ { "name": "serviceId", "type": "string", "info": "Filters the response by a service ID.: string", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "regionId", "type": "string", "info": "Filters the response by a region ID.: string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "resourceName", "type": "string", "info": "Filters the response by a specified resource name.: string", "required": false, "schema": { "title": "resourceName", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filters the response by a project ID.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "domainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "domainId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listLimits" }, "task": true }, { "name": "createLimits", "summary": "Create Limits", "description": "Create Limits", "input": [ { "name": "body", "type": "object", "info": ": {\"limits\": [{\"service_id\": \"string\", \"project_id\": \"string\", \"region_id\": \"string\", \"resource_name\": \"string\", \"resource_limit\": 123, \"description\": \"string\"}]}", "required": false, "schema": { "type": "object", "properties": { "limits": { "type": "array", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "project_id": { "type": "string" }, "region_id": { "type": "string" }, "resource_name": { "type": "string" }, "resource_limit": { "type": "integer" }, "description": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLimits" }, "task": true }, { "name": "updateLimit", "summary": "Update Limit", "description": "Update Limit", "input": [ { "name": "limitId", "type": "string", "info": "The limit ID.: string", "required": true, "schema": { "title": "limitId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"limit\": {\"resource_limit\": 123, \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "limit": { "type": "object", "properties": { "resource_limit": { "type": "integer" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateLimit" }, "task": true }, { "name": "showLimitDetails", "summary": "Show Limit Details", "description": "Show Limit Details", "input": [ { "name": "limitId", "type": "string", "info": "The limit ID.: string", "required": true, "schema": { "title": "limitId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLimitDetails" }, "task": true }, { "name": "deleteLimit", "summary": "Delete Limit", "description": "Delete Limit", "input": [ { "name": "limitId", "type": "string", "info": "The limit ID.: string", "required": true, "schema": { "title": "limitId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLimit" }, "task": true }, { "name": "listUsers", "summary": "List users", "description": "List users", "input": [ { "name": "domainId", "type": "string", "info": "Filters the response by a domain ID.: string", "required": false, "schema": { "title": "domainId", "type": "string" } }, { "name": "enabled", "type": "string", "info": "Filters the response by either enabled (true) or disabled (false) users.: string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "idpId", "type": "string", "info": "Filters the response by an identity provider ID.: string", "required": false, "schema": { "title": "idpId", "type": "string" } }, { "name": "name", "type": "string", "info": "Filters the response by a user name.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "passwordExpiresAt", "type": "string", "info": "Filter results based on which user passwords have expired. The query should include an operator and a timestamp with a colon (:) separating the two, for example:: string", "required": false, "schema": { "title": "passwordExpiresAt", "type": "string" } }, { "name": "protocolId", "type": "string", "info": "Filters the response by a protocol ID.: string", "required": false, "schema": { "title": "protocolId", "type": "string" } }, { "name": "uniqueId", "type": "string", "info": "Filters the response by a unique ID.: string", "required": false, "schema": { "title": "uniqueId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listUsers" }, "task": true }, { "name": "createUser", "summary": "Create user", "description": "Create user", "input": [ { "name": "body", "type": "object", "info": ": {\"user\": {\"default_project_id\": \"string\", \"domain_id\": \"string\", \"enabled\": \"boolean\", \"federated\": [{\"idp_id\": \"string\", \"protocols\": [{\"protocol_id\": \"string\", \"unique_id\": \"string\"}]}], \"name\": \"string\", \"password\": \"string\", \"description\": \"string\", \"email\": \"string\", \"options\": {\"ignore_password_expiry\": \"boolean\"}}}", "required": false, "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "default_project_id": { "type": "string" }, "domain_id": { "type": "string" }, "enabled": { "type": "boolean" }, "federated": { "type": "array", "items": { "type": "object", "properties": { "idp_id": { "type": "string" }, "protocols": { "type": "array", "items": { "type": "object", "properties": { "protocol_id": { "type": "string" }, "unique_id": { "type": "string" } } } } } } }, "name": { "type": "string" }, "password": { "type": "string" }, "description": { "type": "string" }, "email": { "type": "string" }, "options": { "type": "object", "properties": { "ignore_password_expiry": { "type": "boolean" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createUser" }, "task": true }, { "name": "showUserDetails", "summary": "Show user details", "description": "Show user details", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUserDetails" }, "task": true }, { "name": "updateUser", "summary": "Update user", "description": "Update user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"user\": {\"default_project_id\": \"string\", \"enabled\": \"boolean\", \"options\": {\"ignore_lockout_failure_attempts\": \"boolean\"}}}", "required": false, "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "default_project_id": { "type": "string" }, "enabled": { "type": "boolean" }, "options": { "type": "object", "properties": { "ignore_lockout_failure_attempts": { "type": "boolean" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUser" }, "task": true }, { "name": "deleteUser", "summary": "Delete user", "description": "Delete user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUser" }, "task": true }, { "name": "listGroupsToWhichAUserBelongs", "summary": "List groups to which a user belongs", "description": "List groups to which a user belongs", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listGroupsToWhichAUserBelongs" }, "task": true }, { "name": "listProjectsForUser", "summary": "List projects for user", "description": "List projects for user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listProjectsForUser" }, "task": true }, { "name": "changePasswordForUser", "summary": "Change password for user", "description": "Change password for user", "input": [ { "name": "userId", "type": "string", "info": "The user ID.: string", "required": true, "schema": { "title": "userId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"user\": {\"password\": \"string\", \"original_password\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "password": { "type": "string" }, "original_password": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/changePasswordForUser" }, "task": true } ], "views": [] }