GroupService_CreateGroup

POST 
/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/groups

GroupService_CreateGroup

Request

Path Parameters

metadata.partner stringrequired

Partner to which the resource belongs

metadata.organization stringrequired

Organization to which the resource belongs

application/json

Body

required

apiVersion API Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the group resource

kind Kindrequired

Default value: Group

Kind of the group resource

metadata objectrequired

metadata of the resource

name Name

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 Project

Project of the resource

spec objectrequired

Metadata of the group resource

projectNamespaceRoles object[]

Project, namespace, role associations for group

Array [

project Project

Project

namespace Namespace

Namespace

role Role

Role

group Group

Group

]

users string[]

List of users for group

type Type

Type of group

status object

Status of the resource

application/yaml

Body

required

apiVersion API Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the group resource

kind Kindrequired

Default value: Group

Kind of the group resource

metadata objectrequired

metadata of the resource

name Name

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 Project

Project of the resource

spec objectrequired

Metadata of the group resource

projectNamespaceRoles object[]

Project, namespace, role associations for group

Array [

project Project

Project

namespace Namespace

Namespace

role Role

Role

group Group

Group

]

users string[]

List of users for group

type Type

Type of group

status object

Status of the resource

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the group resource

kind Kindrequired

Default value: Group

Kind of the group resource

metadata objectrequired
Metadata of the group 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 group resource

projectNamespaceRoles object[]

Project, namespace, role associations for group

Array [

project Project

Project

namespace Namespace

Namespace

role Role

Role

group Group

Group

]

users string[]

List of users for group

type Type

Type of group

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": "system.k8smgmt.io/v3",
  "kind": "Group",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "projectNamespaceRoles": [
      {
        "project": "string",
        "namespace": "string",
        "role": "string",
        "group": "string"
      }
    ],
    "users": [
      "string"
    ],
    "type": "string"
  },
  "status": {
    "conditionType": "string",
    "conditionStatus": "StatusNotSet",
    "lastUpdated": "2024-02-15T00:40:10.705Z",
    "reason": "string"
  }
}

application/yaml

Schema

Schema

apiVersion API Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the group resource

kind Kindrequired

Default value: Group

Kind of the group resource

metadata objectrequired
Metadata of the group 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 group resource

projectNamespaceRoles object[]

Project, namespace, role associations for group

Array [

project Project

Project

namespace Namespace

Namespace

role Role

Role

group Group

Group

]

users string[]

List of users for group

type Type

Type of group

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": "system.k8smgmt.io/v3",
  "kind": "Group",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "projectNamespaceRoles": [
      {
        "project": "string",
        "namespace": "string",
        "role": "string",
        "group": "string"
      }
    ],
    "users": [
      "string"
    ],
    "type": "string"
  },
  "status": {
    "conditionType": "string",
    "conditionStatus": "StatusNotSet",
    "lastUpdated": "2024-02-15T00:40:10.706Z",
    "reason": "string"
  }
}

201

Returned when group is created successfully.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

403

Returned when the group 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...