Skip to content

Instantly share code, notes, and snippets.

@vidyabijoor

vidyabijoor/gist:12d1966fbd6c32d0b2114fdc2f0e9233

Last active April 30, 2024 09:47
Show Gist options
  • Save vidyabijoor/12d1966fbd6c32d0b2114fdc2f0e9233 to your computer and use it in GitHub Desktop.
Save vidyabijoor/12d1966fbd6c32d0b2114fdc2f0e9233 to your computer and use it in GitHub Desktop.
Download ZIP
account_type
Raw
gistfile1.txt
{
"swagger": "2.0",
"info": {
"description": "Kochava IAM API",
"title": "Kochava IAM API",
"version": "1.18"
},
"host": "localhost:8080",
"basePath": "/service/",
"paths": {
"/logos/upload": {
"post": {
"description": "This endpoint is used for uploading an organization logo.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Upload the logo for an organization",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"description": "Upload the logo for an organization. The file format should be JPEG, JPG, or PNG, and the maximum file size should be 5MB or less.",
"name": "file",
"in": "formData",
"required": true,
"type": "file"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/upload.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/logos/download": {
"post": {
"description": "This endpoint is used to download the logo for an organization.",
"produces": [
"application/octet-stream",
"application/json"
],
"tags": [
"Organization"
],
"summary": "Download the logo for an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"description": "The request body contains the URL path for downloading the logo.",
"name": "LogoDownload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/logo.download"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string",
"format": "binary"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations": {
"get": {
"description": "This endpoint is used to retrieve a list of organizations associated with the user.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Get a list of organizations that the user belongs to",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"post": {
"description": "This endpoint is used to create a new organization. If operation is successful, the response body \n\r\ncontains the newly created organization details.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Create an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"description": "The request body includes the details of the organization to be created.",
"name": "Organization",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/organization.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}": {
"put": {
"description": "This endpoint is used to update an organization details.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Update an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body includes the updated information of the organization.",
"name": "Organization",
"in": "body",
"schema": {
"$ref": "#/definitions/organization.update"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete an organization. Please note that executing this operation will result in the removal of all the users, user groups, workspaces, resources, invitations and policies associated with the organization being deleted.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Delete an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to get an organization details.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Get an organization details",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces": {
"get": {
"description": "This endpoint retrieves a list of all the workspaces of an organization.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Get a list of all the workspaces of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.work_space.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"post": {
"description": "This endpoint is used to create a new workspace. If successful, the response body \n\r\ncontains the newly created workspace details.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Create a workspace",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the workspace to be created.",
"name": "Workspace",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.work_space.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/organization.work_space.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete all the workspaces of an organization. Please note that executing this operation will result in the removal of all resources and policies associated with the workspaces being deleted.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Delete all workspaces",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}": {
"delete": {
"description": "This endpoint is used to delete a workspace. Please note that executing this operation will result in the removal of all resources and policies associated with the workspace being deleted.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Delete a workspace",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"put": {
"description": "This endpoint is used to update the details of workspace.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Update the details of a workspace.",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the information that needs to be updated for the workspace.",
"name": "Workspace",
"in": "body",
"schema": {
"$ref": "#/definitions/organization.work_space.update"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.work_space.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve the details of a workspace.",
"produces": [
"application/json"
],
"tags": [
"Workspace"
],
"summary": "Get the details of a workspace.",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.work_space.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/resources": {
"post": {
"description": "This endpoint is used to register a resource to an organization.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Register a resource to an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the resource to be created.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/resource.create"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve a list of all resources belonging to an organization.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get all the resources of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "All the resources belonging to the specified resource type.",
"name": "type",
"in": "query",
"maxLength": 64,
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/resources.list"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/resources/{resource_id}": {
"put": {
"description": "This endpoint is utilized to update a resource within an organization.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Update an organization resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The resources belonging to the specified resource ID.",
"name": "resource_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the resource to be updated.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/resource.update"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resource.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve the details of an organization resource.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get an organization resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The resources belonging to the specified resource ID.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resource.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to unregister resource from an organization.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Unregister resource from an organization resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Unique ID of the actual resource which is managed or created by the product.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/resources": {
"post": {
"description": "This endpoint is used to register a resource to the workspace.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Register a resource to the workspace",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the resource to be created.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/resource.create"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to get a list of all the resources in a workspace.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get a list of all the resources in a workspace",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Get the details of resources belonging to a specific resource type.",
"name": "type",
"in": "query",
"maxLength": 64,
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resources.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/resources/{resource_id}": {
"put": {
"description": "This endpoint is utilized to update a resource within an workspace.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Update a workspace resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The workspace resource belonging to the specified resource ID.",
"name": "resource_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the resource to be updated.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/resource.update"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resource.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve a workspace resource based on its resource ID.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get a specific workspace resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The workspace resource belonging to the specified resource ID.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resource.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to unregister resource from the workspace.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Unregister resource from the workspace",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Unique ID of the actual resource which is managed or created by the product.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/resources": {
"post": {
"description": "This endpoint is used to register a global resource.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Register a global resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"description": "The request body contains the details of the resource to be created.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/resource.create"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve a list of all global resources.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get all the global resources",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"description": "All the resources belonging to the specified resource type.",
"name": "type",
"in": "query",
"maxLength": 64,
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/resources.list"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/resources/{resource_id}": {
"get": {
"description": "This endpoint is used to retrieve the details of a global resource.",
"produces": [
"application/json"
],
"tags": [
"Query Resource"
],
"summary": "Get global resource details",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "The resources belonging to the specified resource ID.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/resource.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to unregister global resource.",
"produces": [
"application/json"
],
"tags": [
"Register/Unregister Resource"
],
"summary": "Unregister global resource",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Unique ID of the actual resource which is managed or created by the product.",
"name": "resource_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/team": {
"get": {
"description": "This endpoint is used to get list of user and user-group details of an organization.",
"produces": [
"application/json"
],
"tags": [
"Team"
],
"summary": "Get a list of user and user-group details of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"enum": [
"INVOKED",
"PENDING",
"ACCEPTED",
"REJECTED",
"EXPIRED"
],
"description": "The status of the invitation.",
"name": "status",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/team.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/team/delete": {
"post": {
"description": "This endpoint is used to delete a list of users and user groups in the organization team.",
"produces": [
"application/json"
],
"tags": [
"Team"
],
"summary": "Delete a list of users and user groups in the organization team",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body includes a list of users IDs and user groups IDs that are being deleted.",
"name": "team_delete",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/team.delete.list"
}
}
],
"responses": {
"207": {
"description": "Multi-Status",
"schema": {
"$ref": "#/definitions/team.multi.status.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/team/delete": {
"post": {
"description": "This endpoint is used to delete a list of users and user groups in the workspace team.",
"produces": [
"application/json"
],
"tags": [
"Team"
],
"summary": "Delete a list of users and user groups in the workspace team",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"description": "The request body includes a list of users IDs and user groups IDs that are being deleted.",
"name": "team_delete",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/team.delete.list"
}
}
],
"responses": {
"207": {
"description": "Multi-Status",
"schema": {
"$ref": "#/definitions/team.multi.status.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/users": {
"get": {
"description": "This endpoint is used to retrieve a list of all the users of an organization.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get a list of all the users of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/users.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete all users of an organization.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Delete all users of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/users/{user_id}": {
"get": {
"description": "This endpoint is used to retrieve information about a user of an organization.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get the details of a user of an organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user.",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/user.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete an organization user.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Delete an organization user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user that is being deleted.",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/users/{user_id}": {
"delete": {
"description": "This endpoint is used to delete a user from all organizations.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Delete a user from all organizations",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user that is being deleted from all organizations.",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups": {
"get": {
"description": "This endpoint is utilized to retrieve a list of all user groups within an organization.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "List of User Groups",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.user.groups.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"post": {
"description": "This endpoint is utilized to create a new user group within an organization. Upon successful request, the response body will contain the details of the newly created user group.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Create User Group",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body should contain the necessary details of the user group that needs to be created.",
"name": "UserGroup",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.user.group.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/model.user.groups.create.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete all user groups from the organization.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Delete All User Groups",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups/{group_id}/users": {
"get": {
"description": "This endpoint is utilized to retrieve a list of all users belonging to the user group.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "List of Users",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The user belongs to the specified User Group ID.",
"name": "group_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/users.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"post": {
"description": "This endpoint is utilized to add users to the user group.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Add Users",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The users will be added to the specified User Group.",
"name": "group_id",
"in": "path",
"required": true
},
{
"description": "The request body includes a list of user IDs for the users that will be added to the user group.",
"name": "User",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/user.id.invite"
}
}
],
"responses": {
"207": {
"description": "Multi-Status",
"schema": {
"$ref": "#/definitions/multi_status.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups/{group_id}": {
"get": {
"description": "This endpoint is used to retrieve information about a user group of an organization.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Get User Group Details",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group of an organization.",
"name": "group_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.user.groups"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is utilized to delete a user group within an organization.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Delete a user group",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Unique ID of the user group to be removed from the organization.",
"name": "group_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"put": {
"description": "This endpoint is utilized to update an organization user group.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Update User Group",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group of an organization.",
"name": "group_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the updated details of the user group.",
"name": "UserGroup",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.user.group.update"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/model.user.groups.update.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups/{group_id}/users/{user_id}": {
"delete": {
"description": "This endpoint is used to remove a user from a user group.",
"produces": [
"application/json"
],
"tags": [
"User Group"
],
"summary": "Remove User",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group from which the user is being deleted.",
"name": "group_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user that is being removed from the user group.",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-invitations": {
"post": {
"description": "This endpoint is used to send an invitation to users to join the organization or organization user groups.",
"produces": [
"application/json"
],
"tags": [
"User Invite"
],
"summary": "Send an invitation to users to join the organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the user invitation to be created.",
"name": "UserInvite",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/user.invite"
}
}
}
],
"responses": {
"207": {
"description": "Multi-Status",
"schema": {
"$ref": "#/definitions/multi_status.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve a list of all invitations within the organization.",
"produces": [
"application/json"
],
"tags": [
"User Invite"
],
"summary": "Get a list of all invitations within the organization",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/invite.invitationData.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/user-invitations": {
"get": {
"description": "This endpoint is used to retrieve a list of all sent or received invitations.",
"produces": [
"application/json"
],
"tags": [
"User Invite"
],
"summary": "Get a list of all sent or received invitations",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"enum": [
"sent",
"received"
],
"description": "The type of invitation: sent or received.",
"name": "type",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/invitation.sent.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/user-invitations/{invitation_id}": {
"put": {
"description": "This endpoint is used to accept or reject an invitation.",
"produces": [
"application/json"
],
"tags": [
"User Invite"
],
"summary": "Accept or reject an invitation",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the invitation.",
"name": "invitation_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the information about the accept or reject an organization invitation.",
"name": "InviteAction",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/invite.acceptInvite"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to revoke an organization invitation.",
"produces": [
"application/json"
],
"tags": [
"User Invite"
],
"summary": "Revoke an organization invitation",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the invitation that is being deleted.",
"name": "invitation_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/roles": {
"get": {
"description": "This endpoint is used retrieve a list of all roles and their associated capabilities.",
"produces": [
"application/json"
],
"tags": [
"Roles and Capabilities"
],
"summary": "List of Roles",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
},
{
"type": "string",
"enum": [
"ORG",
"WS",
"GLOBAL",
"RESOURCE"
],
"description": "The scope of the role.",
"name": "level",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/roles.list"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/policies/{policy_id}": {
"delete": {
"description": "This endpoint is used to delete a policy.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "Delete a policy",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy that is being deleted.",
"name": "policy_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/policies/delete": {
"post": {
"description": "This endpoint is used to delete a policy by using policy details.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "Delete a policy by using policy details",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the policy to be deleted. Note : role_name in the request is only for api-key(headless api requests) based request.",
"name": "Policy",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/policy.create"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/policies": {
"post": {
"description": "This endpoint is used to create a new policy. If the request is successful, the response body will contain the newly created policy details.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "Create a new policy",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the policy to be created. Note : role_name in the request is only for api-key(headless api requests) based request.",
"name": "Policy",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/policy.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/policy.create.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"409": {
"description": "Conflict",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"put": {
"description": "This endpoint is used to update a list of policies.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "Update a list of policies",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains a list of policy details to be updated. Note : role_name in the request is only for api-key(headless api requests) based request.",
"name": "Policy",
"in": "body",
"schema": {
"$ref": "#/definitions/policy.update.list"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve a list of all policies whose role associated with organization.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for Organization-level Roles",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of all policies whose role associated with workspace.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for Workspace-level Roles",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/my-policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the current user whose role is associate with this organization.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for Current User's Organization-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/users/{user_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the user whose role is associate with this organization.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for User's Organization-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user to whom the policy belongs.",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/users/{user_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the user whose role is associate with this workspace.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for User's Workspace-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user to whom the policy belongs.",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups/{group_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the user group whose role is associate with this organization.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for User groups's Organization-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group to which the policy belongs.",
"name": "group_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/user-groups/{group_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the user group whose role is associate with this workspace.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for User group's Workspace-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group to which the policy belongs.",
"name": "group_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/role/{role_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the role which is associate with this organization.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for Specific Organization-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which the policy belongs.",
"name": "role_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/workspaces/{workspace_id}/role/{role_id}/policies": {
"get": {
"description": "This endpoint is used to retrieve a list of policies of the role which is associate with this workspace.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "List of Policies for Specific Workspace-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Workspace ID",
"name": "workspace_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which the policy belongs.",
"name": "role_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/users/{user_id}/policies/workspaces": {
"get": {
"description": "This endpoint used to retrieve workspaces of the user whose role is associated to those workspaces.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "User's Workspaces Associated with Workspace-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user to whom the policy belongs.",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.workspace.list.name"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user-groups/{group_id}/policies/workspaces": {
"get": {
"description": "This endpoint used to retrieve workspaces of the user group whose role is associated to those workspaces.",
"produces": [
"application/json"
],
"tags": [
"Policy"
],
"summary": "User group's Workspaces Associated with Workspace-level Role",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group to which the policy belongs.",
"name": "group_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/policy.workspace.list.name"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/acc-mappings": {
"get": {
"description": "This endpoint is used to retrieve m/OS organization to product account mappings.",
"produces": [
"application/json"
],
"tags": [
"Accounts"
],
"summary": "Get m/OS organization to product account mappings",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/acc_mappings.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/account/reset-password": {
"get": {
"description": "This endpoint is used to access user invitation password recovery email link.",
"produces": [
"application/json"
],
"tags": [
"Public"
],
"summary": "Get password recovery code for the user invitation email link.",
"parameters": [
{
"type": "string",
"description": "Unique invitation link id.",
"name": "id",
"in": "query",
"required": true
}
],
"responses": {
"302": {
"description": "Found"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/sso/provider": {
"post": {
"description": "This endpoint is used to get sso provider id for the given user email.\n1. When no sso provider is configured for the given domain then api returns 204(No Content).\n2. When m/OS account doesn't exist for the given email then api returns 422(Unprocessable Entity) with error message in the response body.",
"produces": [
"application/json"
],
"tags": [
"Public"
],
"summary": "Get sso provider id for the given user email",
"parameters": [
{
"description": "The request body includes the user email address.",
"name": "Sso",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/sso.provider.get.request"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/sso.provider.get.response"
}
},
"204": {
"description": "No content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
},
"examples": {
"application/json": {
"id": 5530007,
"message": "Please reach out to your organization's administrator to request an invitation.",
"type": "error",
"context": ""
}
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user/apikeys": {
"post": {
"description": "This endpoint is used to create an user API key.",
"produces": [
"application/json"
],
"tags": [
"API Keys"
],
"summary": "Create an API key for the current user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the API key to be added to an organization.",
"name": "ApiKey",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.apikey.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api_key"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"get": {
"description": "This endpoint is used to retrieve list of all API keys of an user.",
"produces": [
"application/json"
],
"tags": [
"API Keys"
],
"summary": "Get list of all API keys of the current user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"enum": [
"current",
"all"
],
"description": "filter by scope. Default value is current.",
"name": "scope",
"in": "query",
"required": false
},
{
"type": "string",
"description": "Page size.",
"name": "limit",
"in": "query",
"required": false,
"minimum": 1,
"maximum": 100
},
{
"type": "string",
"description": "Pagination cursor, value represent base64 string.",
"name": "cursor",
"in": "query",
"required": false,
"maxLength": 256
},
{
"type": "string",
"enum": [
"after",
"before"
],
"description": "Pagination direction.",
"name": "direction",
"in": "query",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api_keys.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user/apikeys/{apikey_id}": {
"get": {
"description": "This endpoint is used to retrieve details of a API key of an user.",
"produces": [
"application/json"
],
"tags": [
"API Keys"
],
"summary": "Get details of a API key of the current user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"type": "string",
"format": "uuid",
"description": "API key ID",
"name": "apikey_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api_key"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_id}/user/apikeys/delete": {
"post": {
"description": "This endpoint is used to delete user API keys.",
"produces": [
"application/json"
],
"tags": [
"API Keys"
],
"summary": "Delete API keys of the current user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Organization ID",
"name": "organization_id",
"in": "path",
"required": true
},
{
"description": "The request body contains the IDs of the API keys to be deleted.",
"name": "ApiKey",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apikey.delete.list"
}
}
],
"responses": {
"207": {
"description": "Multi-Status",
"schema": {
"$ref": "#/definitions/team.multi.status.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/my-details": {
"get": {
"description": "This endpoint is utilized to fetch detailed information about the current user associated with all the organization.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Retrieve information about the current user",
"parameters": [
{
"type": "string",
"description": "Set the Cookie Header. Must include the HTTP Cookie Header which originally was received in the response \n\r\nheader of login session.\n\r\nExample : iam_session_id=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9D\n\r\nWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny\n\r\n3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f== \n\r\n It is ok if more than one cookie are included here as all other cookies will be ignored. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "Cookie",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A. \n\r\n Note: Either a Cookie or an API key should be included in the request. The API key is utilized exclusively for headless API requests, while for UI requests, cookies must always be used.",
"name": "api-key",
"in": "header",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/my.detail.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/checkpermission": {
"post": {
"description": "This endpoint is used to check permission to access a resource for the current user.",
"produces": [
"application/json"
],
"tags": [
"Permission"
],
"summary": "Check permission to access a resource for the current user",
"parameters": [
{
"type": "string",
"description": "Set the api-key Header. Must include the HTTP api-key created in m/OS platform.\n\r\nExample: api-key=BAF66EB7-825E-4C3D-BB6A-533A9D37084A.",
"name": "api-key",
"in": "header",
"required": true
},
{
"description": "The request body contains the details of the resource, user and relation.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/permission.check"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
}
},
"definitions": {
"organization.create": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the organization."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the organization."
},
"website": {
"type": "string",
"format": "uri",
"maxLength": 1024,
"pattern": "^(https?|http?)://",
"description": "Optional. The URL of the organization's website."
},
"logo_url": {
"type": "string",
"maxLength": 1024,
"format": "uri",
"pattern": "^(https?|http?)://",
"description": "Optional. The path to the uploaded organization logo. Please note that you should upload the logo first and then use the URL path of the uploaded logo here."
},
"account_type": {
"type": "array",
"description": "Optional. Specifies the account type of organization. The default status is '0' which means 'publisher'",
"items": {
"type": "integer"
}
}
}
},
"organization.update": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The current unique name of the organization that will be updated with new details."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the organization."
},
"website": {
"type": "string",
"format": "uri",
"maxLength": 1024,
"pattern": "^(https?|http?)://",
"description": "Optional. The URL of the organization's website."
},
"logo_url": {
"type": "string",
"maxLength": 1024,
"format": "uri",
"pattern": "^(https?|http?)://",
"description": "Optional. The path to the uploaded organization logo. Please note that you should upload the logo first and then use the URL path of the uploaded logo here."
},
"add_account_type": {
"type": "array",
"description": "Optional. Specifies the list of values to be appended to an existing account type of organization.",
"items": {
"type": "integer"
}
},
"delete_account_type": {
"type": "array",
"description": "Optional. Specifies the list of values to be removed from an existing account type of organization.",
"items": {
"type": "integer"
}
}
}
},
"organization.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization."
},
"name": {
"type": "string",
"description": "The name of the organization."
},
"website": {
"type": "string",
"description": "The URL of the organization's website."
},
"logo_url": {
"type": "string",
"description": "The path to the organization's logo."
},
"description": {
"type": "string",
"description": "A brief description of the organization."
},
"created_time": {
"type": "string",
"description": "The creation time of the organization, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the organization. For example: \"2014-10-02T15:01:23Z\"."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this organization."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this organization."
},
"account_type": {
"type": "array",
"description": "Specifies the account type of organization.",
"items": {
"type": "integer"
}
},
"products":{
"type": "array",
"items": {
"$ref": "#/definitions/product_info"
}
}
}
},
"organization.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of organization details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/organization.response"
}
}
}
},
"organization.work_space.create": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the workspace."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the workspace."
}
}
},
"organization.work_space.update": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The current unique name of the workspace that will be updated with new details."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the organization."
}
}
},
"organization.work_space.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the workspace."
},
"name": {
"type": "string",
"description": "The name of the workspace."
},
"description": {
"type": "string",
"description": "A brief description of the workspace."
},
"created_time": {
"type": "string",
"description": "The creation time of the workspace, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the workspace. For example: \"2014-10-02T15:01:23Z\"."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this workspace."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this workspace."
}
}
},
"organization.work_space.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of workspace details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"workspaces": {
"type": "array",
"items": {
"$ref": "#/definitions/organization.work_space.response"
}
}
}
},
"resource.update": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the resource."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the resource."
}
}
},
"resource.create": {
"type": "object",
"required": [
"name",
"type",
"id"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the resource."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the resource."
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The name of the resource type that is already available in the system. Please note that you may need to configure and deploy a new resource type in the system if it is not already available. Presently there is no custom resource type available in the system."
},
"id": {
"type": "string",
"pattern": "^[ A-Za-z0-9-]*$",
"minLength": 1,
"maxLength": 64,
"description": "Unique ID of the actual resource which is managed or created by the product."
}
}
},
"resource.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the actual resource which is managed or created by the product."
},
"name": {
"type": "string",
"description": "The name of the resource."
},
"description": {
"type": "string",
"description": "A brief description of the resource."
},
"type": {
"type": "string",
"description": "The resource type to which the registered resource belongs."
}
}
},
"resources.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of resource details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/definitions/resource.response"
}
}
}
},
"user.traits": {
"type": "object",
"properties": {
"meta_data": {
"type": "string",
"format": "json",
"description": "The meta data of the user, example: \"meta_data\": \"{\"avatar\": \"string\"}\""
},
"departments": {
"description": "List all the departments.",
"$ref": "#/definitions/department.list"
}
}
},
"team.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of user or user group details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"team": {
"description": "Details of users and user-group in the organization. If is_user is true then user_groups fields may be empty/null or list of user-group to which user is belongs to and users field will be null. If is_user is false then user_groups fields may be empty or null and users field will contains list of user who belongs to this user-group. ",
"type": "array",
"items": {
"$ref": "#/definitions/team.response"
}
}
}
},
"team.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for the user or user group."
},
"is_user": {
"type": "boolean",
"description": "Response contains user or user group details. When true, it means user details, and when false, it means user group details."
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the user is active or inactive."
},
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user or user group."
},
"user_first_name": {
"type": "string",
"description": "The first name of the user."
},
"user_last_name": {
"type": "string",
"description": "The last name of the user."
},
"user_display_name": {
"type": "string",
"description": "The display name of the user."
},
"user_group_name": {
"type": "string",
"description": "The name of the user group."
},
"traits": {
"description": "The user or user group traits.",
"$ref": "#/definitions/user.traits"
},
"created_time": {
"type": "string",
"description": "The creation time of the user or user group details, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the user or user group details. For example: \"2014-10-02T15:01:23Z\"."
},
"invitation_status": {
"enum": [
"INVOKED",
"PENDING",
"ACCEPTED",
"REJECTED",
"EXPIRED"
],
"description": "The status of the invitation, indicating whether it is invoked, pending, accepted, rejected or expired. If the user is self signed up then this field will be empty."
},
"users": {
"description": "List of users in the user group.",
"$ref": "#/definitions/team_detail_usergroup.user.list"
},
"user_groups": {
"description": "List of user group names to which the user belongs.",
"$ref": "#/definitions/my_detail_usergroup.list"
},
"policies": {
"description": "List all the policies.",
"$ref": "#/definitions/team_policy.list"
}
}
},
"delete_team_member": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for either the user or user group. If is_user is true, this field contains the user ID. If is_user is false, this field contains the user group ID."
},
"is_user": {
"type": "boolean",
"description": "When true, it means the user will be deleting, and when false, it means that user group will be deleting."
}
}
},
"team.delete.list": {
"type": "object",
"properties": {
"team": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"description": "The list of existing user IDs or user group IDS to be deleted.",
"items": {
"$ref": "#/definitions/delete_team_member"
}
}
}
},
"user.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for the user."
},
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user."
},
"first_name": {
"type": "string",
"description": "The first name of the user."
},
"last_name": {
"type": "string",
"description": "The last name of the user."
},
"display_name": {
"type": "string",
"description": "The display name of the user."
},
"created_time": {
"type": "string",
"description": "The creation time of the user details, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the user details. For example: \"2014-10-02T15:01:23Z\"."
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the user is active or inactive."
},
"invitation_status": {
"enum": [
"INVOKED",
"PENDING",
"ACCEPTED",
"REJECTED",
"EXPIRED"
],
"description": "The status of the invitation, indicating whether it is invoked, pending, accepted, rejected or expired. If the user is self signed up then this field will be empty."
}
}
},
"users.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of user details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/user.response"
}
}
}
},
"roles.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of roles included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/role.get"
}
}
}
},
"role.get": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the role."
},
"name": {
"type": "string",
"description": "The unique name of the role."
},
"description": {
"type": "string",
"description": "A brief description of the role."
},
"scope": {
"type": "string",
"description": "The scope at which the role is associated. For example, \"ORG\" represents organization level, and \"WS\" represents workspace level."
},
"display_name": {
"type": "string",
"description": "The display name of the role."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/definitions/role.capability.get"
}
}
}
},
"role.capability.get": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the role capability."
},
"name": {
"type": "string",
"description": "The unique name of the role capability."
},
"description": {
"type": "string",
"description": "A brief description of the capability."
},
"resource_type": {
"type": "string",
"description": "The unique name of the resource type."
},
"service": {
"type": "string",
"description": "The service of the rersource type."
},
"operation": {
"type": "string",
"description": "The operation of the rersource type."
}
}
},
"department.list": {
"type": "array",
"items": {
"type": "string"
}
},
"acc_mappings.response": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of account mappings included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"acc_mappings": {
"$ref": "#/definitions/acc_mappings.list"
}
}
},
"acc_mappings.list": {
"type": "array",
"items": {
"$ref": "#/definitions/acc_mapping"
}
},
"acc_mapping": {
"type": "object",
"required": [
"product",
"account_id"
],
"properties": {
"product": {
"type": "string",
"enum": [
"Kochava",
"SAM"
],
"description": "The product name."
},
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The account id."
},
"api_key": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The api key."
}
}
},
"team.multi.status.response": {
"type": "array",
"items": {
"$ref": "#/definitions/multistatus.error.response"
}
},
"team_policy.list": {
"type": "array",
"items": {
"$ref": "#/definitions/team_user_policy"
}
},
"team_user_policy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy."
},
"level": {
"type": "string",
"enum": ["ORG", "WS", "RESOURCE"],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"level_name": {
"type": "string",
"description": "The name of the organization or workspace depends on the level. If the level is \"ORG\", then this field contains the organization name. If the level is \"WS\", then this field contains the workspace name. If the level is \"RESOURCE\", then this field contains the resource instance name."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which this policy is associated."
},
"role_name": {
"type": "string",
"description": "The role with which the policy is associated."
},
"role_display_name": {
"type": "string",
"description": "The display name of the role."
},
"inherited_group": {
"description": "List all the inherited policies.",
"$ref": "#/definitions/my_detail_policy.inherit"
}
}
},
"policy.create": {
"type": "object",
"required": [
"is_user",
"user_or_group_id",
"level",
"level_id",
"role_id"
],
"properties": {
"is_user": {
"type": "boolean",
"description": "The policy is for either a user or a user group. When true, it means the policy is for a user, and when false, it means the policy is for a user group."
},
"user_or_group_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID for either the user or user group. If is_user is true, this field contains the user ID. If is_user is false, this field contains the user group ID."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"minLength": 1,
"maxLength": 64,
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"role_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the role that will be associated with the policy."
},
"role_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The role with which the policy is associated. Note : role_name in the request is only for api-key(headless api requests) based request."
}
}
},
"policy.update.list": {
"type": "object",
"properties": {
"update_policies": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"$ref": "#/definitions/policy.update"
}
}
}
},
"policy.update": {
"type": "object",
"required": [
"operation"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy. This field is optional when creating a new policy but mandatory when updating or deleting an existing policy."
},
"operation": {
"type": "string",
"enum": [
"0",
"1",
"2"
],
"description": "The action to be performed on the policy request. \n\r\n0: Add a new policy (the ID should be empty in this case).\n\r\n1: Update an existing policy (the ID should contain the existing policy ID).\n\r\n2: Delete an existing policy (the ID should contain the existing policy ID)."
},
"is_user": {
"type": "boolean",
"description": "The create or update or delete policy is associated with either a user or a user group. When set to true, it indicates that the policy is for a user. When set to false, it indicates that the policy is for a user group. This field is mandatory when creating a new policy or updating an existing policy, optional incase of deleting existing policy."
},
"user_or_group_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID for either the user or the user group. If is_user is true, then this field contains the user ID. If is_user is false, then this field contains the user group ID. This field is mandatory when creating a new policy or updating an existing policy, optional incase of deleting existing policy."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"minLength": 1,
"maxLength": 64,
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level. This field is mandatory when creating a new policy or updating an existing policy, optional incase of deleting existing policy."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID.. This field is mandatory when creating a new policy or updating an existing policy, optional incase of deleting existing policy."
},
"role_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the role that will be associated with the policy.. This field is mandatory when creating a new policy or updating an existing policy, optional incase of deleting existing policy."
},
"role_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The role with which the policy is associated. Note : role_name in the request is only for api-key(headless api requests) based request."
}
}
},
"user.group.policy.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"level_name": {
"type": "string",
"description": "The name of the organization or workspace depends on the level. If the level is \"ORG\", then this field contains the organization name. If the level is \"WS\", then this field contains the workspace name. If the level is \"RESOURCE\", then this field contains the resource instance name."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which this policy is associated."
},
"role_name": {
"type": "string",
"description": "The role with which the policy is associated."
},
"role_display_name": {
"type": "string",
"description": "The display name of the role."
}
}
},
"policy.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy."
},
"is_user": {
"type": "boolean",
"description": "The policy is associated with either a user or a user group. When set to true, it indicates that the policy is for a user. When set to false, it indicates that the policy is for a user group."
},
"user_or_group_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for either the user or user group. If is_user is true, this field contains the user ID. If is_user is false, this field contains the user group ID."
},
"user_or_group_name": {
"type": "string",
"description": "The name of the user or user group associated with the policy. If is_user is true, then this field contains the user name. If is_user is false, then this field contains the user group name."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"level_name": {
"type": "string",
"description": "The name of the organization or workspace depends on the level. If the level is \"ORG\", then this field contains the organization name. If the level is \"WS\", then this field contains the workspace name. If the level is \"RESOURCE\", then this field contains the resource instance name."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which this policy is associated."
},
"role_name": {
"type": "string",
"description": "The role with which the policy is associated."
},
"role_display_name": {
"type": "string",
"description": "The display name of the role."
}
}
},
"policy.create.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy."
},
"is_user": {
"type": "boolean",
"description": "The policy is for either a user or a user group. When true, it means the policy is for a user, and when false, it means the policy is for a user group."
},
"user_or_group_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for either the user or the user group. If is_user is true, then this field contains the user ID. If is_user is false, then this field contains the user group ID."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which this policy is associated."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this policy."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this policy."
}
}
},
"policy.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of policies included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"policies": {
"type": "array",
"description": "List all the policies.",
"items": {
"$ref": "#/definitions/policy.response"
}
}
}
},
"policy.workspace.list.name": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of workspaces included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"workspaces": {
"type": "array",
"description": "A list of workspace names.",
"items": {
"$ref": "#/definitions/workspace"
}
}
}
},
"invite.invitationData.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of invitations included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"invitations": {
"type": "array",
"items": {
"$ref": "#/definitions/invite.invitationData"
}
}
}
},
"invite.invitationData": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the invitation."
},
"inviter_name": {
"type": "string",
"description": "The name of the invited user."
},
"inviter_email": {
"type": "string",
"description": "The email address of the invited user."
},
"inviter_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the invited user."
},
"invitee_name": {
"type": "string",
"description": "The name of the invitee who received the invitation."
},
"invitee_email": {
"type": "string",
"description": "The email address of the invitee who received the invitation."
},
"invitee_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the invitee who received the invitation."
},
"status": {
"type": "string",
"enum": [
"INVOKED",
"PENDING",
"ACCEPTED",
"REJECTED",
"EXPIRED"
],
"description": "The status of the invitation, indicating whether it is invoked, pending, accepted, rejected \n\r\nor expired."
},
"created_time": {
"type": "string",
"description": "The creation time of the invitation, expressed as a timestamp in UTC. \n\r\nFor example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the invitation. \n\r\nFor example: \"2014-10-02T15:01:23Z\"."
},
"roles": {
"type": "array",
"description": "The list of roles to which the user has been invited.",
"items": {
"$ref": "#/definitions/invite.roleData"
}
},
"user_groups": {
"type": "array",
"description": "The list of user groups to which the user has been added.",
"items": {
"$ref": "#/definitions/invite.user.groups"
}
}
}
},
"invitation.sent.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of invitations included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"invitations": {
"type": "array",
"items": {
"$ref": "#/definitions/invitation.sent"
}
}
}
},
"invitation.sent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the invitation."
},
"name": {
"type": "string",
"description": "The name of the inviter for received invitation or invitee for sent invitation."
},
"email": {
"type": "string",
"description": "The email address of the inviter for received invitation or invitee for sent invitation."
},
"user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the inviter for received invitation or invitee for sent invitation."
},
"status": {
"type": "string",
"enum": [
"INVOKED",
"PENDING",
"ACCEPTED",
"REJECTED",
"EXPIRED"
],
"description": "The status of the invitation, indicating whether it is invoked, pending, accepted, rejected or expired."
},
"created_time": {
"type": "string",
"description": "The creation time of the invitation, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the invitation. For example: \"2014-10-02T15:01:23Z\"."
},
"roles": {
"type": "array",
"description": "The list of roles to which the user has been invited.",
"items": {
"$ref": "#/definitions/invite.roleData"
}
},
"user_groups": {
"type": "array",
"description": "The list of user groups to which the user has been added.",
"items": {
"$ref": "#/definitions/invite.user.groups"
}
}
}
},
"invite.roleData": {
"type": "object",
"properties": {
"role_name": {
"type": "string",
"description": "The name of the role to which the user has been invited."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which the user has been invited."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"level_name": {
"type": "string",
"description": "The name of the organization or workspace depends on the level. If the level is \"ORG\", then this field contains the organization name. If the level is \"WS\", then this field contains the workspace name. If the level is \"RESOURCE\", then this field contains the resource instance name."
}
}
},
"model.user.group.update": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The new name for the existing user group. If it is empty, then there will be no change in the existing user group name."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the user group to be updated."
},
"join_user_ids": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. A list of user IDs for the users to be added to the user group.",
"items": {
"type": "string",
"format": "uuid"
}
},
"exit_user_ids": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. A list of user IDs for the users to be removed from the user group.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"model.user.group.create": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The name of the user group."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the user group."
},
"user_ids": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. A list of user IDs for the users to be added to the user group. If the list is empty, the user group will be created without any users.",
"items": {
"type": "string",
"format": "uuid"
}
},
"policies": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. The list of roles to be assigned to the user group. If the policy list is empty, then only the user group is created, and the default OrgUser role will be assigned to the newly created user group.",
"items": {
"$ref": "#/definitions/user.group.policy.create"
}
}
}
},
"user.group.policy.create": {
"type": "object",
"required": [
"role_id"
],
"properties": {
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"minLength": 1,
"maxLength": 64,
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level. Default is organization level."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"role_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique ID of the role, which will be assigned to the user group."
}
}
},
"model.user.group": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The name of the user group."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the user group."
}
}
},
"model.user.groups.list": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of user group details included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"user_groups": {
"type": "array",
"items": {
"$ref": "#/definitions/model.user.groups"
}
}
}
},
"model.user.groups.create.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group."
},
"name": {
"type": "string",
"description": "The name of the user group."
},
"description": {
"type": "string",
"description": "A brief description of the user group."
},
"created_time": {
"type": "string",
"description": "The creation time of the user group, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the user group. For example: \"2014-10-02T15:01:23Z\"."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this user group."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this user group."
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/user.response"
}
},
"policies": {
"type": "array",
"description": "List all the policies.",
"items": {
"$ref": "#/definitions/user.group.policy.response"
}
}
}
},
"invite.user.groups": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group."
},
"name": {
"type": "string",
"description": "The name of the user group."
}
}
},
"model.user.groups.update.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group."
},
"name": {
"type": "string",
"description": "The name of the user group."
},
"description": {
"type": "string",
"description": "A brief description of the user group."
},
"created_time": {
"type": "string",
"description": "The creation time of the user group, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the user group. For example: \"2014-10-02T15:01:23Z\"."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this user group."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this user group."
}
}
},
"model.user.groups": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user group."
},
"name": {
"type": "string",
"description": "The name of the user group."
},
"description": {
"type": "string",
"description": "A brief description of the user group."
},
"created_time": {
"type": "string",
"description": "The creation time of the user group, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the user group. For example: \"2014-10-02T15:01:23Z\"."
},
"created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who created this user group."
},
"updated_by_user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user who updated this user group."
},
"policies": {
"type": "array",
"description": "List all the policies.",
"items": {
"$ref": "#/definitions/user.group.policy.response"
}
}
}
},
"invite.acceptInvite": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"ACCEPT",
"REJECT"
],
"description": "Accept or reject the organization invitation."
}
}
},
"user.invite": {
"type": "object",
"required": [
"email",
"user_group_ids"
],
"properties": {
"email": {
"type": "string",
"minLength": 3,
"maxLength": 128,
"format": "email",
"description": "The email address of the invited user."
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The first name of the invited user."
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The last name of the invited user."
},
"roles": {
"type": "array",
"minItems": 0,
"maxItems": 20,
"description": "Optional. List of roles the invited user would be assigned to.",
"items": {
"$ref": "#/definitions/user.invite.role"
}
},
"user_group_ids": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "A list of user group IDs to which the user will be added.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"user.invite.role": {
"type": "object",
"required": [
"role",
"level",
"level_id"
],
"properties": {
"role_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the role to which the invited user will be assigned."
},
"level": {
"type": "string",
"enum": [
"ORG",
"WS",
"RESOURCE"
],
"minLength": 1,
"maxLength": 64,
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
}
}
},
"multi_status.response": {
"type": "array",
"items": {
"$ref": "#/definitions/multistatus.error.response"
}
},
"error.response": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Error code. \n\r\nDetails of error code is available at https://docs.google.com/spreadsheets/d/139Vb5s4bqv7HthlJHRpUDyBBm-533YsRvc8cHIf6CT8/edit#gid=0"
},
"message": {
"type": "string",
"description": "Error reason. \n\r\nDetails of error reason is available at https://docs.google.com/spreadsheets/d/139Vb5s4bqv7HthlJHRpUDyBBm-533YsRvc8cHIf6CT8/edit#gid=0"
},
"type": {
"type": "string",
"description": "Error type, example: error, warning."
},
"context": {
"type": "string",
"description": "Additional information related to error."
}
}
},
"multistatus.error.response": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP status code."
},
"id": {
"type": "integer",
"description": "Error code. \n\r\nDetails of error code is available at https://docs.google.com/spreadsheets/d/139Vb5s4bqv7HthlJHRpUDyBBm-533YsRvc8cHIf6CT8/edit#gid=0"
},
"message": {
"type": "string",
"description": "Error reason. \n\r\nDetails of error reason is available at https://docs.google.com/spreadsheets/d/139Vb5s4bqv7HthlJHRpUDyBBm-533YsRvc8cHIf6CT8/edit#gid=0"
},
"type": {
"type": "string",
"description": "Error type, example: error, warning."
},
"context": {
"type": "string",
"description": "Additional information related to error."
}
}
},
"user.id.invite": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_ids": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "The list of user IDs for the users to be added to the user group.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"policy.delete.list": {
"type": "object",
"properties": {
"policy_ids": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"description": "The list of existing policy IDs to be deleted.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"upload.response": {
"type": "object",
"properties": {
"logo_url": {
"type": "string",
"description": "The URL path of the organization logo."
}
}
},
"logo.download": {
"type": "object",
"required": [
"logo_url"
],
"properties": {
"logo_url": {
"type": "string",
"description": "The URL path of the organization logo."
}
}
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the workspace."
},
"name": {
"type": "string",
"description": "The name of the workspace."
}
}
},
"sso.provider.get.request": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"minLength": 3,
"maxLength": 128,
"description": "The email address of the user."
}
}
},
"sso.provider.get.response": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The sso provider id."
}
}
},
"organization.apikey.create": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The API key name."
}
}
},
"apikey.delete.list": {
"type": "object",
"properties": {
"apikeys": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"description": "The list of API key IDs to be deleted.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"api_keys.response": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "The number of API keys included in the response."
},
"prev_cursor": {
"type": "string",
"description": "The previous cursor used for backward pagination, omittable."
},
"next_cursor": {
"type": "string",
"description": "The next cursor used for forward pagination, omittable."
},
"apikeys": {
"$ref": "#/definitions/api_keys.list"
}
}
},
"api_keys.list": {
"type": "array",
"items": {
"$ref": "#/definitions/api_key"
}
},
"api_key": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id of the API key."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The API key name."
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The API key value."
},
"user_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for the user."
},
"user_email": {
"type": "string",
"format": "email",
"description": "The email address of the user."
},
"created_time": {
"type": "string",
"description": "The creation time of the API key, expressed as a timestamp in UTC. For example: \"2014-10-02T15:01:23Z\"."
},
"updated_time": {
"type": "string",
"description": "The timestamp in UTC indicating the most recent modification time of the API key. For example: \"2014-10-02T15:01:23Z\"."
}
}
},
"my.detail.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for the user."
},
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user or user group."
},
"first_name": {
"type": "string",
"description": "The first name of the user."
},
"last_name": {
"type": "string",
"description": "The last name of the user."
},
"display_name": {
"type": "string",
"description": "The display name of the user."
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the user is active or inactive."
},
"organizations": {
"description": "List of organizations to which the user belongs.",
"type": "array",
"items": {
"$ref": "#/definitions/my_detail_org.response"
}
}
}
},
"my_detail_org.response": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the organization."
},
"name": {
"type": "string",
"description": "The name of the organization."
},
"website": {
"type": "string",
"description": "The URL of the organization's website."
},
"invitation_status": {
"enum": ["INVOKED", "PENDING", "ACCEPTED", "REJECTED", "EXPIRED"],
"description": "The status of the invitation, indicating whether it is invoked, pending, accepted, rejected or expired. If the user is self signed up then this field will be empty."
},
"user_groups": {
"description": "List of user group names to which the user belongs.",
"$ref": "#/definitions/my_detail_usergroup.list"
},
"policies": {
"description": "List all the policies.",
"$ref": "#/definitions/my_detail_policy.list"
},
"products": {
"description": "List all the products.",
"$ref": "#/definitions/my_detail_product.list"
}
}
},
"team_detail_usergroup.user.list": {
"type": "array",
"items": {
"$ref": "#/definitions/team_detail_usergroup.user"
}
},
"team_detail_usergroup.user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID for the user."
},
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user."
},
"first_name": {
"type": "string",
"description": "The first name of the user."
},
"last_name": {
"type": "string",
"description": "The last name of the user."
},
"display_name": {
"type": "string",
"description": "The display name of the user."
}
}
},
"my_detail_usergroup.list": {
"type": "array",
"items": {
"$ref": "#/definitions/my_detail_usergroup"
}
},
"my_detail_usergroup": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the usergroup."
},
"name": {
"type": "string",
"description": "The name of the usergroup."
}
}
},
"my_detail_policy.list": {
"type": "array",
"items": {
"$ref": "#/definitions/my_detail_policy"
}
},
"my_detail_policy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the policy."
},
"level": {
"type": "string",
"enum": ["ORG", "WS", "RESOURCE"],
"description": "The level at which the role is associated. For example, \"ORG\" represents organization level, \"WS\" represents workspace level and \"RESOURCE\" represents resource instance level."
},
"level_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"format": "uuid",
"description": "The unique ID of the organization or workspace or resource instance depends on the above level. If the level is \"ORG\", then this field contains the organization ID. If the level is \"WS\", then this field contains the workspace ID. If the level is \"RESOURCE\", then this field contains the resource instance ID."
},
"level_name": {
"type": "string",
"description": "The name of the organization or workspace depends on the level. If the level is \"ORG\", then this field contains the organization name. If the level is \"WS\", then this field contains the workspace name. If the level is \"RESOURCE\", then this field contains the resource instance name."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the role to which this policy is associated."
},
"role_name": {
"type": "string",
"description": "The role with which the policy is associated."
},
"role_display_name": {
"type": "string",
"description": "The display name of the role."
},
"inherited_group": {
"description": "List all the inherited policies.",
"$ref": "#/definitions/my_detail_policy.inherit"
}
}
},
"my_detail_policy.inherit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the usergroup."
},
"name": {
"type": "string",
"description": "The name of the usergroup."
}
}
},
"permission.check": {
"type": "object",
"required": [
"resource_id",
"permission",
"user_id"
],
"properties": {
"resource_id": {
"type": "string",
"pattern": "^[ A-Za-z0-9-]*$",
"minLength": 1,
"maxLength": 64,
"description": "The unique id of the resource."
},
"permission": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The permission details."
},
"user_id": {
"type": "string",
"pattern": "^[ A-Za-z0-9-]*$",
"minLength": 1,
"maxLength": 64,
"description": "The unique id of the user."
}
}
},
"my_detail_product.list": {
"type": "array",
"items": {
"$ref": "#/definitions/my_detail_product"
}
},
"my_detail_product": {
"type": "object",
"properties": {
"prod_type": {
"type": "string",
"description": "The field specifies the type of product for which the organization has been created."
},
"p_user_id": {
"type": "integer",
"description": "The unique ID of the user in the product."
},
"p_account_id": {
"type": "integer",
"description": "The unique ID of the account in the product."
},
"p_api_keys": {
"description": "List all the apikeys of the user.",
"type": "array",
"items": {
"$ref": "#/definitions/my_detail_product.apikey.list"
}
}
}
},
"my_detail_product.apikey.list": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The field specifies the type of apikey."
},
"key": {
"type": "string",
"description": "The field specifies the api key value."
}
}
},
"product_info": {
"type": "object",
"properties": {
"prod_type": {
"type": "string",
"description": "The field specifies the type of product for which the organization has been created."
},
"p_account_id": {
"type": "integer",
"description": "The unique ID of the account in the product."
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment