Files
Nirav Parikh dd563582d0 adding permissions for cli.config.read and code fix for non admin use… (#313)
* adding permissions for cli.config.read and code fix for non admin users cli config download

Signed-off-by: Nirav Parikh <nir.parikh05@gmail.com>

* includes changes for nix, go version 1.21 and addressed review comments

Signed-off-by: nirparikh05 <nir.parikh05@gmail.com>

* fixed lints

Signed-off-by: nirparikh05 <nir.parikh05@gmail.com>

---------

Signed-off-by: Nirav Parikh <nir.parikh05@gmail.com>
Signed-off-by: nirparikh05 <nir.parikh05@gmail.com>
2024-06-03 12:57:00 +05:30

1085 lines
29 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "Identity Provider (IdP) Service",
"version": "3.0",
"contact": {
"name": "Paralus Dev"
}
},
"tags": [
{
"name": "IdpService"
}
],
"schemes": [
"https"
],
"consumes": [
"application/json",
"application/yaml"
],
"produces": [
"application/json",
"application/yaml"
],
"paths": {
"/auth/v3/sso/idp": {
"get": {
"operationId": "IdpService_ListIdps",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3IdpList"
}
},
"403": {
"description": "Returned when the user does not have permission to access the resource.",
"schema": {}
},
"404": {
"description": "Returned when the resource does not exist.",
"schema": {
"type": "string",
"format": "string"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"tags": [
"IdpService"
]
},
"post": {
"operationId": "IdpService_CreateIdp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3Idp"
}
},
"201": {
"description": "Returned when idp is created successfully.",
"schema": {}
},
"403": {
"description": "Returned when the user does not have permission to access the resource.",
"schema": {}
},
"404": {
"description": "Returned when the resource does not exist.",
"schema": {
"type": "string",
"format": "string"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "body",
"description": "Idp",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v3Idp"
}
}
],
"tags": [
"IdpService"
]
}
},
"/auth/v3/sso/idp/{metadata.name}": {
"get": {
"operationId": "IdpService_GetIdp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3Idp"
}
},
"403": {
"description": "Returned when the user does not have permission to access the resource.",
"schema": {}
},
"404": {
"description": "Returned when the resource does not exist.",
"schema": {
"type": "string",
"format": "string"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "metadata.name",
"description": "name of the resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "apiVersion",
"description": "API Version\n\nAPI Version of the idp resource",
"in": "query",
"required": true,
"type": "string",
"default": "system.k8smgmt.io/v3"
},
{
"name": "kind",
"description": "Kind\n\nKind of the idp resource",
"in": "query",
"required": true,
"type": "string",
"default": "Idp"
},
{
"name": "metadata.displayName",
"description": "Display Name\n\ndisplay name of the resource",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.description",
"description": "Description\n\ndescription of the resource",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.labels",
"description": "Labels\n\nThis is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.annotations",
"description": "Annotations\n\nThis is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.project",
"description": "Project\n\nProject of the resource",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "metadata.organization",
"description": "Organization\n\nOrganization to which the resource belongs",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.partner",
"description": "Partner\n\nPartner to which the resource belongs",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.urlScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.createdAt",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "metadata.modifiedAt",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "spec.idpName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.domain",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.acsUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.ssoUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.idpCert",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.spCert",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.metadataUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.metadataFilename",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.saeEnabled",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "spec.groupAttributeName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.nameIdFormat",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.consumerBinding",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.spEntityId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status.conditionType",
"description": "Condition Type\n\ntype of the status condition",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status.conditionStatus",
"description": "Condition Status\n\nstatus of the condition",
"in": "query",
"required": false,
"type": "string",
"enum": [
"StatusNotSet",
"StatusSubmitted",
"StatusOK",
"StatusFailed"
],
"default": "StatusNotSet"
},
{
"name": "status.lastUpdated",
"description": "Last Updated\n\nwhen the condition status is last updated",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "status.reason",
"description": "Reason\n\nreason of the last condition status",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"IdpService"
]
},
"delete": {
"operationId": "IdpService_DeleteIdp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3Empty"
}
},
"204": {
"description": "Returned when idp is deleted successfully.",
"schema": {}
},
"403": {
"description": "Returned when the user does not have permission to access the resource.",
"schema": {}
},
"404": {
"description": "Returned when the resource does not exist.",
"schema": {
"type": "string",
"format": "string"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "metadata.name",
"description": "name of the resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "apiVersion",
"description": "API Version\n\nAPI Version of the idp resource",
"in": "query",
"required": true,
"type": "string",
"default": "system.k8smgmt.io/v3"
},
{
"name": "kind",
"description": "Kind\n\nKind of the idp resource",
"in": "query",
"required": true,
"type": "string",
"default": "Idp"
},
{
"name": "metadata.displayName",
"description": "Display Name\n\ndisplay name of the resource",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.description",
"description": "Description\n\ndescription of the resource",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.labels",
"description": "Labels\n\nThis is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.annotations",
"description": "Annotations\n\nThis is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.project",
"description": "Project\n\nProject of the resource",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "metadata.organization",
"description": "Organization\n\nOrganization to which the resource belongs",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.partner",
"description": "Partner\n\nPartner to which the resource belongs",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.urlScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "metadata.createdAt",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "metadata.modifiedAt",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "spec.idpName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.domain",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.acsUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.ssoUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.idpCert",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.spCert",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.metadataUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.metadataFilename",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.saeEnabled",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "spec.groupAttributeName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.nameIdFormat",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.consumerBinding",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.spEntityId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status.conditionType",
"description": "Condition Type\n\ntype of the status condition",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status.conditionStatus",
"description": "Condition Status\n\nstatus of the condition",
"in": "query",
"required": false,
"type": "string",
"enum": [
"StatusNotSet",
"StatusSubmitted",
"StatusOK",
"StatusFailed"
],
"default": "StatusNotSet"
},
{
"name": "status.lastUpdated",
"description": "Last Updated\n\nwhen the condition status is last updated",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "status.reason",
"description": "Reason\n\nreason of the last condition status",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"IdpService"
]
},
"put": {
"operationId": "IdpService_UpdateIdp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3Idp"
}
},
"403": {
"description": "Returned when the user does not have permission to access the resource.",
"schema": {}
},
"404": {
"description": "Returned when the resource does not exist.",
"schema": {
"type": "string",
"format": "string"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/googlerpcStatus"
}
}
},
"parameters": [
{
"name": "metadata.name",
"description": "name of the resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/IdpServiceUpdateIdpBody"
}
}
],
"tags": [
"IdpService"
]
}
}
},
"definitions": {
"IdpServiceUpdateIdpBody": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the idp resource",
"title": "API Version"
},
"kind": {
"type": "string",
"default": "Idp",
"description": "Kind of the idp resource",
"title": "Kind"
},
"metadata": {
"type": "object",
"example": {
"name": "some-name",
"project": "defaultproject"
},
"properties": {
"displayName": {
"type": "string",
"description": "display name of the resource",
"title": "Display Name"
},
"description": {
"type": "string",
"description": "description of the resource",
"title": "Description"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "labels of the resource",
"title": "Labels"
},
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "annotations of the resource",
"title": "Annotations"
},
"project": {
"type": "string",
"description": "Project of the resource",
"title": "Project"
},
"organization": {
"type": "string",
"description": "Organization to which the resource belongs",
"title": "Organization"
},
"partner": {
"type": "string",
"description": "Partner to which the resource belongs",
"title": "Partner"
},
"id": {
"type": "string",
"readOnly": true
},
"urlScope": {
"type": "string",
"readOnly": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"description": "metadata of the resource",
"title": "Metadata"
},
"spec": {
"$ref": "#/definitions/v3IdpSpec",
"description": "Spec of the idp resource",
"title": "Spec"
},
"status": {
"$ref": "#/definitions/commonv3Status",
"description": "Status of the resource",
"title": "Status",
"readOnly": true
}
},
"description": "Idp",
"title": "Idp",
"required": [
"apiVersion",
"kind",
"metadata",
"spec",
"project"
]
},
"commonv3Status": {
"type": "object",
"properties": {
"conditionType": {
"type": "string",
"description": "type of the status condition",
"title": "Condition Type",
"readOnly": true
},
"conditionStatus": {
"$ref": "#/definitions/v3ConditionStatus",
"enum": [
"StatusNotSet",
"StatusSubmitted",
"StatusOK",
"StatusFailed"
],
"description": "status of the condition",
"title": "Condition Status",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"description": "when the condition status is last updated",
"title": "Last Updated",
"readOnly": true
},
"reason": {
"type": "string",
"description": "reason of the last condition status",
"title": "Reason",
"readOnly": true
}
},
"description": "status of a resource",
"title": "Status",
"readOnly": true
},
"googlerpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"v3ConditionStatus": {
"type": "string",
"enum": [
"StatusNotSet",
"StatusSubmitted",
"StatusOK",
"StatusFailed"
],
"default": "StatusNotSet",
"title": "$title: ConditionStatus\n$description: status of a condition for a resource"
},
"v3Empty": {
"type": "object",
"title": "Empty is an empty message"
},
"v3Idp": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the idp resource",
"title": "API Version"
},
"kind": {
"type": "string",
"default": "Idp",
"description": "Kind of the idp resource",
"title": "Kind"
},
"metadata": {
"$ref": "#/definitions/v3Metadata",
"description": "Metadata of the idp resource",
"title": "Metadata"
},
"spec": {
"$ref": "#/definitions/v3IdpSpec",
"description": "Spec of the idp resource",
"title": "Spec"
},
"status": {
"$ref": "#/definitions/commonv3Status",
"description": "Status of the resource",
"title": "Status",
"readOnly": true
}
},
"description": "Idp",
"title": "Idp",
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
]
},
"v3IdpList": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the idp list resource",
"title": "API Version",
"readOnly": true
},
"kind": {
"type": "string",
"default": "IdpList",
"description": "Kind of the idp list resource",
"title": "Kind",
"readOnly": true
},
"metadata": {
"$ref": "#/definitions/v3ListMetadata",
"description": "Metadata of the idp list resource",
"title": "Metadata",
"readOnly": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v3Idp",
"readOnly": true
},
"description": "List of the idp resources",
"title": "Items"
}
},
"description": "idp list",
"title": "IdpList",
"readOnly": true
},
"v3IdpSpec": {
"type": "object",
"properties": {
"idpName": {
"type": "string"
},
"domain": {
"type": "string"
},
"acsUrl": {
"type": "string"
},
"ssoUrl": {
"type": "string"
},
"idpCert": {
"type": "string"
},
"spCert": {
"type": "string"
},
"metadataUrl": {
"type": "string"
},
"metadataFilename": {
"type": "string"
},
"saeEnabled": {
"type": "boolean"
},
"groupAttributeName": {
"type": "string"
},
"nameIdFormat": {
"type": "string"
},
"consumerBinding": {
"type": "string"
},
"spEntityId": {
"type": "string"
}
}
},
"v3ListMetadata": {
"type": "object",
"properties": {
"count": {
"type": "string",
"format": "int64"
},
"offset": {
"type": "string",
"format": "int64"
},
"limit": {
"type": "string",
"format": "int64"
}
},
"title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled"
},
"v3Metadata": {
"type": "object",
"example": {
"name": "some-name",
"project": "defaultproject"
},
"properties": {
"name": {
"type": "string",
"description": "name of the resource",
"title": "Name"
},
"displayName": {
"type": "string",
"description": "display name of the resource",
"title": "Display Name"
},
"description": {
"type": "string",
"description": "description of the resource",
"title": "Description"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "labels of the resource",
"title": "Labels"
},
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "annotations of the resource",
"title": "Annotations"
},
"project": {
"type": "string",
"description": "Project of the resource",
"title": "Project"
},
"organization": {
"type": "string",
"description": "Organization to which the resource belongs",
"title": "Organization"
},
"partner": {
"type": "string",
"description": "Partner to which the resource belongs",
"title": "Partner"
},
"id": {
"type": "string",
"readOnly": true
},
"urlScope": {
"type": "string",
"readOnly": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"description": "metadata of the resource",
"title": "Metadata",
"required": [
"name",
"project"
]
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "X-API-KEYID",
"in": "header"
},
"ApiTokenAuth": {
"type": "apiKey",
"name": "X-API-TOKEN",
"in": "header"
},
"BasicAuth": {
"type": "basic"
}
},
"security": [
{
"ApiKeyAuth": [],
"ApiTokenAuth": [],
"BasicAuth": []
}
]
}