github/paralus
1
0
Fork 0
mirror of https://github.com/paralus/paralus.git synced 2026-08-24 15:47:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
paralus/gen/openapi/proto/rpc/system/oidc_provider.swagger.json
T
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

1097 lines
31 KiB
JSON
Raw Permalink Blame History

{
"swagger": "2.0",
"info": {
"title": "OIdC Provider Service",
"version": "3.0",
"contact": {
"name": "Paralus Dev"
}
},
"tags": [
{
"name": "OIDCProviderService"
}
],
"schemes": [
"https"
],
"consumes": [
"application/json",
"application/yaml"
],
"produces": [
"application/json",
"application/yaml"
],
"paths": {
"/auth/v3/sso/oidc/provider": {
"get": {
"operationId": "OIDCProviderService_ListOIDCProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3OIDCProviderList"
}
},
"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": [
"OIDCProviderService"
]
},
"post": {
"operationId": "OIDCProviderService_CreateOIDCProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3OIDCProvider"
}
},
"201": {
"description": "Returned when oidc provider 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": "Open Id Connect Provider",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v3OIDCProvider"
}
}
],
"tags": [
"OIDCProviderService"
]
}
},
"/auth/v3/sso/oidc/provider/{metadata.name}": {
"get": {
"operationId": "OIDCProviderService_GetOIDCProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3OIDCProvider"
}
},
"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 OIDCProvider resource",
"in": "query",
"required": true,
"type": "string",
"default": "system.k8smgmt.io/v3"
},
{
"name": "kind",
"description": "Kind\n\nKind of the OIDCProvider resource",
"in": "query",
"required": true,
"type": "string",
"default": "OIDCProvider"
},
{
"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.providerName",
"description": "enumeration?",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.mapperUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.mapperFilename",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.clientId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.clientSecret",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.scopes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "spec.issuerUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.authUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.tokenUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.requestedClaims",
"description": "JSON object",
"in": "query",
"required": false,
"type": "object"
},
{
"name": "spec.predefined",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "spec.callbackUrl",
"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": [
"OIDCProviderService"
]
},
"delete": {
"operationId": "OIDCProviderService_DeleteOIDCProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3Empty"
}
},
"204": {
"description": "Returned when oidc provider 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 OIDCProvider resource",
"in": "query",
"required": true,
"type": "string",
"default": "system.k8smgmt.io/v3"
},
{
"name": "kind",
"description": "Kind\n\nKind of the OIDCProvider resource",
"in": "query",
"required": true,
"type": "string",
"default": "OIDCProvider"
},
{
"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.providerName",
"description": "enumeration?",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.mapperUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.mapperFilename",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.clientId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.clientSecret",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.scopes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "spec.issuerUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.authUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.tokenUrl",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "spec.requestedClaims",
"description": "JSON object",
"in": "query",
"required": false,
"type": "object"
},
{
"name": "spec.predefined",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "spec.callbackUrl",
"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": [
"OIDCProviderService"
]
},
"put": {
"operationId": "OIDCProviderService_UpdateOIDCProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v3OIDCProvider"
}
},
"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/OIDCProviderServiceUpdateOIDCProviderBody"
}
}
],
"tags": [
"OIDCProviderService"
]
}
}
},
"definitions": {
"OIDCProviderServiceUpdateOIDCProviderBody": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the OIDCProvider resource",
"title": "API Version"
},
"kind": {
"type": "string",
"default": "OIDCProvider",
"description": "Kind of the OIDCProvider 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/v3OIDCProviderSpec",
"description": "Spec of the OIDCProvider resource",
"title": "Spec"
},
"status": {
"$ref": "#/definitions/commonv3Status",
"description": "Status of the resource",
"title": "Status",
"readOnly": true
}
},
"description": "Open Id Connect Provider",
"title": "OIDCProvider",
"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": {}
},
"protobufNullValue": {
"type": "string",
"enum": [
"NULL_VALUE"
],
"default": "NULL_VALUE",
"description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value."
},
"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"
},
"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"
]
},
"v3OIDCProvider": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the OIDCProvider resource",
"title": "API Version"
},
"kind": {
"type": "string",
"default": "OIDCProvider",
"description": "Kind of the OIDCProvider resource",
"title": "Kind"
},
"metadata": {
"$ref": "#/definitions/v3Metadata",
"description": "Metadata of the OIDCProvider resource",
"title": "Metadata"
},
"spec": {
"$ref": "#/definitions/v3OIDCProviderSpec",
"description": "Spec of the OIDCProvider resource",
"title": "Spec"
},
"status": {
"$ref": "#/definitions/commonv3Status",
"description": "Status of the resource",
"title": "Status",
"readOnly": true
}
},
"description": "Open Id Connect Provider",
"title": "OIDCProvider",
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
]
},
"v3OIDCProviderList": {
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"default": "system.k8smgmt.io/v3",
"description": "API Version of the OIDCProvider list resource",
"title": "API Version",
"readOnly": true
},
"kind": {
"type": "string",
"default": "OIDCProviderList",
"description": "Kind of the OIDCProvider list resource",
"title": "Kind",
"readOnly": true
},
"metadata": {
"$ref": "#/definitions/v3ListMetadata",
"description": "Metadata of the OIDCProvider list resource",
"title": "Metadata",
"readOnly": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v3OIDCProvider",
"readOnly": true
},
"description": "List of the OIDCProvider resources",
"title": "Items"
}
},
"description": "OIDC providers list",
"title": "OIDCProviderList",
"readOnly": true
},
"v3OIDCProviderSpec": {
"type": "object",
"properties": {
"providerName": {
"type": "string",
"title": "enumeration?"
},
"mapperUrl": {
"type": "string"
},
"mapperFilename": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"issuerUrl": {
"type": "string"
},
"authUrl": {
"type": "string"
},
"tokenUrl": {
"type": "string"
},
"requestedClaims": {
"type": "object",
"title": "JSON object"
},
"predefined": {
"type": "boolean"
},
"callbackUrl": {
"type": "string"
}
},
"description": "OIDCProvider specification",
"title": "OIDCProvider Specification"
}
},
"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": []
}
]
}
Reference in New Issue View Git Blame Copy Permalink