RolepermissionService_GetRolepermissions

GET 
/auth/v3/rolepermissions

RolepermissionService_GetRolepermissions

Request

Query Parameters

q string

query for filtering

name string

name is unique ID of a resource along with (partnerID, organizationID, projectID)

selector string

selector is used to filter the labels of a resource

partner string
organization string
project string
group string
role string
displayName string

displayName only used for update queries to set displayName (READONLY)

labels string

labels only used for update queries to set labels (READONLY)

This 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

annotations string

annotations only used for update queries to set annotations (READONLY)

This 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

count int64
offset int64
limit int64
ignoreScopeDefault boolean

ignoreScopeDefault ignores default values for partnerID, organizationID and projectID

globalScope boolean

globalScope sets partnerID,organizationID,projectID = 0

orderBy string
order string
deleted boolean
extended boolean
urlScope string

urlScope is supposed to be passed in the URL as kind/HashID(value)

isSSOUser boolean
username string
groups string[]
blueprintRef string
publishedVersion string
clusterID string
ID string
account string
type string

generic way to specify a type of resource, mainly for use in users endpoint

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

API Version of the role permission list resource

kind Kind

Kind of the role permission list resource

metadata object
Metadata of the role permission list resource
count int64
offset int64
limit int64
items object[]
List of the role permission resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the role permission resource
kind Kindrequired
Default value: RolePermission
Kind of the role permission resource
metadata objectrequired
Metadata of the role permission resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec objectrequired
Metadata of the role permission resource
scope Scope
Scope of permisions for role
status object
Status of the resource
conditionType Condition Type
type of the status condition
conditionStatus Condition Status
Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]
Default value: StatusNotSet
status of the condition
lastUpdated date-time
when the condition status is last updated
reason Reason
reason of the last condition status
]

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "RolePermission",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "scope": "string"
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.148Z",
        "reason": "string"
      }
    }
  ]
}

application/yaml

Schema

Schema

apiVersion API Version

API Version of the role permission list resource

kind Kind

Kind of the role permission list resource

metadata object
Metadata of the role permission list resource
count int64
offset int64
limit int64
items object[]
List of the role permission resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the role permission resource
kind Kindrequired
Default value: RolePermission
Kind of the role permission resource
metadata objectrequired
Metadata of the role permission resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec objectrequired
Metadata of the role permission resource
scope Scope
Scope of permisions for role
status object
Status of the resource
conditionType Condition Type
type of the status condition
conditionStatus Condition Status
Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]
Default value: StatusNotSet
status of the condition
lastUpdated date-time
when the condition status is last updated
reason Reason
reason of the last condition status
]

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "RolePermission",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "scope": "string"
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.148Z",
        "reason": "string"
      }
    }
  ]
}

403

Returned when the rolepermission does not have permission to access the resource.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

404

Returned when the resource does not exist.

application/json

Schema

Schema

string

application/yaml

Schema

Schema

string

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/yaml

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...