Skip to content

Instantly share code, notes, and snippets.

@vidyabijoor

vidyabijoor/mos_iam_admin_api.json

Last active March 21, 2024 10:31
Show Gist options
  • Save vidyabijoor/fb136bc8b80710c6bc4cb9bb1dcf4827 to your computer and use it in GitHub Desktop.
Save vidyabijoor/fb136bc8b80710c6bc4cb9bb1dcf4827 to your computer and use it in GitHub Desktop.
Download ZIP
api_doc for AS - M/OS migration apis
Raw
mos_iam_admin_api.json
{
"swagger": "2.0",
"info": {
"description": "Kochava IAM Admin API",
"title": "Kochava IAM Admin API",
"version": "1.6"
},
"host": "localhost:8080",
"basePath": "/service/admin/",
"paths": {
"/organizations": {
"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.",
"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"
}
}
}
},
"get": {
"description": "This endpoint is used to get all organizations.",
"produces": [
"application/json"
],
"tags": [
"Organization"
],
"summary": "Get 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.",
"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"
}
},
"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-batch": {
"post": {
"description": "This endpoint facilitates batch creation of new organizations. Upon successful completion of the operation, the response body will include the details of the newly created organizations.",
"produces": [
"application/json"
],
"tags": [
"Migration"
],
"summary": "Create organizations in batch",
"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": "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 list of organizations to be created.",
"name": "Organization",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/organization.create.list"
}
}
}
],
"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"
}
}
}
}
},
"/organization/{organization_id}": {
"put": {
"description": "This endpoint is used to update an organization.",
"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.",
"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 details of the organization to be created.",
"name": "Organization",
"in": "body",
"required": true,
"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"
}
},
"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 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.",
"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"
}
}
}
},
"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.",
"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"
}
}
}
}
},
"/organizations/{organization_name}/domain/{domain_name}": {
"post": {
"description": "This endpoint is used to add an organization user.",
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Add a user 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.",
"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": "Organization name",
"name": "organization_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Domain name",
"name": "domain_name",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the user to be added to an organization. Either the \"org_role\" or \"user_groups\" field needs to be specified for the user to join.",
"name": "User",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.user.create"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"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"
}
}
}
}
},
"/organizations/{organization_id}/users-batch": {
"post": {
"description": "This endpoint facilitates the addition of organization users in batches.",
"produces": [
"application/json"
],
"tags": [
"Migration"
],
"summary": "Add a list of users 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.",
"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 list of users to be added to an organization.",
"name": "User",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/organization.user.create.list"
}
}
}
],
"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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/organizations/{organization_name}/domain/{domain_name}/users/{user_mail}": {
"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.",
"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": "Organization name",
"name": "organization_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Domain name",
"name": "domain_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User email",
"name": "user_mail",
"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_name}/domain/{domain_name}/acc-mappings": {
"post": {
"description": "This endpoint is used to add organization to product account mapping.",
"produces": [
"application/json"
],
"tags": [
"Accounts"
],
"summary": "Add a product account mapping 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.",
"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": "Organization name",
"name": "organization_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Domain name",
"name": "domain_name",
"in": "path",
"required": true
},
{
"description": "The request body contains the details of the product account mapping to be added to an organization.",
"name": "Account",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.account.create"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/organization.account.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"
}
}
}
}
},
"/organizations/{organization_name}/domain/{domain_name}/acc-mappings/{product}": {
"put": {
"description": "This endpoint is used to update an organization's product account mapping.",
"produces": [
"application/json"
],
"tags": [
"Accounts"
],
"summary": "Update an organization to product account mapping",
"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": "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": "Organization name",
"name": "organization_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Domain name",
"name": "domain_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Product name",
"name": "product",
"in": "path",
"required": true,
"enum": [
"Kochava",
"SAM"
]
},
{
"description": "The request body contains the details of the product account mapping to be added to an organization.",
"name": "Account",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/organization.account.update"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/organization.account.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"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete an organization's product account mapping.",
"produces": [
"application/json"
],
"tags": [
"Accounts"
],
"summary": "Delete an organization to product account mapping",
"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": "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": "Organization name",
"name": "organization_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Domain name",
"name": "domain_name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Product name",
"name": "product",
"in": "path",
"required": true,
"enum": [
"Kochava",
"SAM"
]
}
],
"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"
}
}
}
}
},
"/resource-types": {
"post": {
"description": "This endpoint facilitates the addition of a resource type, including its associated services and operations.",
"produces": [
"application/json"
],
"tags": [
"Resource Type"
],
"summary": "Add a resource type",
"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": "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 specifications of the resource type that is to be created.",
"name": "ResourceType",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/resource.type.create"
}
}
}
],
"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"
}
}
}
},
"get": {
"description": "This endpoint is utilized to fetch a comprehensive list of all resource types along with their respective service and operations.",
"produces": [
"application/json"
],
"tags": [
"Resource Type"
],
"summary": "List resource types and its service and operations",
"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": "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": "Resource type identifier. If a resource-type-id is specified, this endpoint is used to retrieve a list of services and their corresponding operations for that specific resource-type-id",
"name": "id",
"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/resource.types.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"
}
}
}
}
},
"/resource-types/{resource_type_id}": {
"post": {
"description": "This endpoint is used to add or delete a list of operations to or from existing resource type. Please note that delete will be blocked and thrown error in case that resource type is already been assigned to one of the user. Only after removing those roles from user policy, the delete would be successful.",
"produces": [
"application/json"
],
"tags": [
"Resource Type"
],
"summary": "Add or delete a list of operations to or from existing resource type",
"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": "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": "Resource type name",
"name": "resource_type",
"in": "path",
"required": true
},
{
"description": "The request body contains a list of services and their operations to be either added or deleted from this resource type.",
"name": "Operations",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 2,
"items": {
"$ref": "#/definitions/resource.type.operations"
}
}
}
],
"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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is designed for deleting a resource type. It's important to note that deletion will be blocked, and an error will be thrown if the resource type is already assigned to a user. Successful deletion can only occur after removing those roles from the user's policy.",
"produces": [
"application/json"
],
"tags": [
"Resource Type"
],
"summary": "Delete a resource type",
"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": "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": "Resource type identifier",
"name": "resource_type_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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/capability": {
"post": {
"description": "This endpoint is utilized to create a capability, which will then be bound to a role. If the resource type, service and operation combination is already exist with a different capability name, this API will return the name of the existing capability. Users can then utilize the existing capability name while creating the role.",
"produces": [
"application/json"
],
"tags": [
"Roles Capability"
],
"summary": "Create a capability",
"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": "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 details of the capability to be created.",
"name": "Capability",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/role.capability.create"
}
}
}
],
"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"
}
}
}
},
"get": {
"description": "This endpoint is used retrieve a list of all the capabilities.",
"produces": [
"application/json"
],
"tags": [
"Roles Capability"
],
"summary": "List all the capabilities",
"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": "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": "This endpoint is utilized to retrieve a list of all capabilities that share the same service.",
"name": "service",
"in": "query",
"maxLength": 64,
"required": false
},
{
"type": "string",
"description": "This endpoint is used retrieve a details of a capability-id.",
"name": "capability_id",
"in": "query",
"maxLength": 64,
"required": false
},
{
"type": "string",
"description": "This endpoint is used retrieve a list of all the capabilities for the resource-type-id.",
"name": "resource_type_id",
"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/role.capability.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/resource-types/{resource_type_id}/capability/{capability_id}": {
"delete": {
"description": "This endpoint is used to delete a capability. It's important to note that deletion will be prevented and an error will be thrown if the capability is already assigned to a user role. Successful deletion can only occur after removing the capability from the associated roles.",
"produces": [
"application/json"
],
"tags": [
"Roles Capability"
],
"summary": "Delete a capability",
"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": "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": "Resource type identifier",
"name": "resource_type_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Capability identifier",
"name": "capability_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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/roles": {
"post": {
"description": "This endpoint is used to create a role with list of capability.",
"produces": [
"application/json"
],
"tags": [
"Roles"
],
"summary": "Create a role with list of capability",
"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": "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 details of the role to be created.",
"name": "RoleCreate",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/definitions/role.create"
}
}
}
],
"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"
}
}
}
},
"get": {
"description": "This endpoint is used retrieve a list of all the roles and its capabilities.",
"produces": [
"application/json"
],
"tags": [
"Roles"
],
"summary": "List all the roles and its capabilities",
"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": "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": "This endpoint is utilized to retrieve a list of all capabilities associated with the specified role.",
"name": "role_id",
"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/role.list"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
},
"/roles/{role_id}": {
"post": {
"description": "This endpoint is used to add or delete capabilities in a role.",
"produces": [
"application/json"
],
"tags": [
"Roles"
],
"summary": "Add or delete capabilities in a 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.",
"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 a list of capability names to be either added or deleted from the role.",
"name": "Resource",
"in": "body",
"required": true,
"schema": {
"type": "array",
"minItems": 1,
"maxItems": 2,
"items": {
"$ref": "#/definitions/role.update.capability"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/role.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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
},
"delete": {
"description": "This endpoint is used to delete a role.",
"produces": [
"application/json"
],
"tags": [
"Roles"
],
"summary": "Delete a 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.",
"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": "Role identifier",
"name": "role_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"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/error.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/error.response"
}
}
}
}
}
},
"definitions": {
"organization.create": {
"type": "object",
"required": [
"name",
"domain"
],
"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."
},
"domain": {
"type": "string",
"maxLength": 255,
"pattern": "^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+[A-Za-z]{2,6}$",
"description": "Organization domain."
},
"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."
},
"traits": {
"$ref": "#/definitions/organization.traits"
}
}
},
"organization.create.list": {
"type": "object",
"required": [
"name",
"account_id"
],
"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."
},
"domain": {
"type": "string",
"maxLength": 255,
"pattern": "^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+[A-Za-z]{2,6}$",
"description": "Organization domain."
},
"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."
},
"migration_source": {
"type": "string",
"maxLength": 64,
"description": "Optional, Indicates the source of the organization record. This field is used to mark records that were created during a migration from the product database. If present, it specifies the source system that generated the record"
},
"status": {
"type": "string",
"maxLength": 64,
"description": "Optional, Indicates the activation status of the organization. Possible values are \"active\" and \"inactive\". If not provided, the default status is \"active\""
},
"account_id": {
"type": "integer",
"description": "Specifies account id within the Advertiser Suite product"
}
}
},
"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."
},
"traits": {
"$ref": "#/definitions/organization.traits"
}
}
},
"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.traits": {
"type": "object",
"properties": {
"meta_data": {
"type": "string",
"format": "json",
"description": "Metadata of the organization."
},
"interests": {
"$ref": "#/definitions/interests.list"
}
}
},
"interests.list": {
"type": "array",
"items": {
"type": "string"
}
},
"organization.user.create": {
"type": "object",
"required": [
"email",
"first_name",
"password"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user."
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The first name of the user."
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The last name of the user."
},
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Optional. The display name of the user."
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Password in plain text."
},
"org_role": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Role name."
},
"username": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"description": "The username of the user."
},
"user_groups": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Comma seperated user group names."
}
}
},
"organization.user.create.list": {
"type": "object",
"required": [
"email",
"first_name",
"password",
"product_user_id"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "The email address of the user."
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The first name of the user."
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The last name of the user."
},
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Optional. The display name of the user."
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Password in plain text."
},
"org_role": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Role name."
},
"username": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"description": "The username of the user."
},
"user_groups": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Comma seperated user group names."
},
"migration_source": {
"type": "string",
"maxLength": 64,
"description": "Optional, Indicates the source of the user record. This field is used to mark records that were created during a migration from the product database. If present, it specifies the source system that generated the record"
},
"api_keys": {
"type": "array",
"minItems": 0,
"maxItems": 20,
"description": "Optional, A list of API keys associated with the user, migrated from Advertiser suite ",
"items": {
"$ref": "#/definitions/product.api_key.create"
}
},
"product_user_id": {
"type": "integer",
"description": "Specifies the user ID within the Advertiser suite"
}
}
},
"organization.account.create": {
"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."
}
}
},
"organization.account.update": {
"type": "object",
"required": [
"account_id"
],
"properties": {
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The account id."
},
"api_key": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The api key."
}
}
},
"organization.account.response": {
"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."
},
"created_time": {
"type": "string",
"description": "The creation time of the organization's product account mapping, 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's product account mapping. For example: \"2014-10-02T15:01:23Z\"."
}
}
},
"error.response": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Internal 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."
}
}
},
"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."
},
"traits": {
"$ref": "#/definitions/organization.traits"
},
"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."
}
}
},
"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"
}
}
}
},
"resource.type.service.operation": {
"type": "object",
"required": [
"service",
"operation"
],
"properties": {
"service": {
"type": "string",
"description": "The permitted service for the specified resource type."
},
"operation": {
"type": "string",
"description": "The permitted operation for the specified resource type and service."
}
}
},
"resource.type.create": {
"type": "object",
"required": [
"name",
"service_operations"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the resource type."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the resource type."
},
"is_global": {
"type": "boolean",
"description": "Optional. If a resource type is marked as global, it does not belong to any specific organization. Default value is false."
},
"service_operations": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"description": "The list of permitted services and operations for the given resource type.",
"items": {
"$ref": "#/definitions/resource.type.service.operation"
}
}
}
},
"resource.type.operations": {
"type": "object",
"required": [
"action",
"service_operations"
],
"properties": {
"action": {
"type": "string",
"enum": [
"0",
"1"
],
"description": "The action to be executed on the resource type. \n\r\n1: To append a list of services and their corresponding operations to an existing resource type.\n\r\n0: To remove a list of services and their associated operations from an existing resource type."
},
"service_operations": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"description": "The permitted services and their associated operations for the specified resource type.",
"items": {
"$ref": "#/definitions/resource.type.service.operation"
}
}
}
},
"resource.types.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."
},
"resource_types": {
"type": "array",
"items": {
"$ref": "#/definitions/resource.types"
}
}
}
},
"resource.types": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the resource type."
},
"name": {
"type": "string",
"description": "The name of the resource type."
},
"description": {
"type": "string",
"description": "A brief description of the resource type."
},
"is_global": {
"type": "boolean",
"description": "If a resource type is marked as global, it does not belong to any specific organization. Default value is false."
},
"service_operations": {
"type": "array",
"description": "The permitted services and their associated operations for the specified resource type.",
"items": {
"$ref": "#/definitions/resource.type.service.operation"
}
}
}
},
"role.capability.create": {
"type": "object",
"required": [
"name",
"resource_type",
"service",
"operation"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the role capability."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the capability."
},
"resource_type_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique identifier of the resource type which is already available in the system."
},
"service": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The service associated with the resource type that is already present in the system."
},
"operation": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The operation associated with the resource type and service that is already present in the system"
}
}
},
"role.capability.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."
},
"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."
}
}
},
"resource.capability.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."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/definitions/role.capability.get"
}
}
}
},
"role.update.capability": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Optional. The new name for the existing role. If it is empty, then there will be no change in the existing role name."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the role to be updated."
},
"display_name": {
"type": "string",
"maxLength": 512,
"description": "Optional. The new display name for the existing role. If it is empty, then there will be no change in the existing display name."
},
"add_capabilities": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. A list of capabilities to be added to the existing role.",
"items": {
"type": "string",
"format": "uuid"
}
},
"remove_capabilities": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"description": "Optional. A list of capabilities to be removed from the existing role.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"role.create": {
"type": "object",
"required": [
"name",
"capabilities"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unique name of the role."
},
"description": {
"type": "string",
"maxLength": 512,
"description": "Optional. A brief description of the role."
},
"role_display_name": {
"type": "string",
"description": "The display name of the role."
},
"scope": {
"type": "string",
"enum": [
"ORG",
"WS",
"BOTH"
],
"description": "The scope at which the role is associated. For example, \"ORG\" represents organization level, and \"WS\" represents workspace level. The default is BOTH."
},
"capabilities": {
"type": "array",
"description": "List of capabilities identifier.",
"items": {
"type": "string"
}
}
}
},
"role.update.response": {
"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."
},
"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."
}
}
},
"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.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."
},
"role_list": {
"type": "array",
"items": {
"$ref": "#/definitions/role.get"
}
}
}
},
"multi_status.response": {
"type": "array",
"items": {
"$ref": "#/definitions/multistatus.error.response"
}
},
"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."
}
}
},
"product.api_key.create": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Optional, API key associated with the user."
},
"type": {
"type": "string",
"minLength": 0,
"maxLength": 512,
"description": "Optional, specifies api key type."
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment