OrganizationService_GetOrganizations

GET 
/auth/v3/partner/{metadata.partner}/organizations

OrganizationService_GetOrganizations

Request

Path Parameters

metadata.partner stringrequired

Partner to which the resource belongs

Query Parameters

apiVersion stringrequired

Default value: system.k8smgmt.io/v3

API Version

API Version of the resource

kind stringrequired

Default value: Organization

Kind

Kind of the resource

metadata.name stringrequired

Name

name of the resource

metadata.displayName string

Display Name

display name of the resource

metadata.description string

Description

description of the resource

metadata.labels string

Labels

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

metadata.annotations string

Annotations

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

metadata.project stringrequired

Project

Project of the resource

metadata.organization string

Organization

Organization to which the resource belongs

metadata.id string
metadata.urlScope string
metadata.createdAt date-time
metadata.modifiedAt date-time
spec.billingAddress string

Billing Address

Billing address of the organization

spec.active boolean

Active

Represents if this organization is active

spec.approved boolean

Approved

Is this organization active

spec.type string

Type

Type of organization

spec.addressLine1 string

Address Line 1

Address of the organization

spec.addressLine2 string

Address Line 2

Address of the organization

spec.city string

City

City

spec.country string

Country

Country of the organization

spec.phone string

Phone

Phone number of the organization

spec.state string

State

State of the organization

spec.zipcode string

Zipcode

Zipcode

spec.isPrivate boolean

Is Private

Is Private Organization

spec.isTotpEnabled boolean

Is TOTP Enabled

Is TOTP enabled at organization level

spec.areClustersShared boolean

Clusters Shared

Are clusters shared

spec.settings.lockout.enabled boolean

Enabled

Is lockout settings enabled?

spec.settings.lockout.periodMin int32

Period Minutes

Lockout period in Minutes

spec.settings.lockout.attempts int32

Attempts

Max number of attempts before lockout

spec.settings.idleLogoutMin int32

Idle Logout Minutes

Idle Logout time in minutes

status.conditionType string

Condition Type

type of the status condition

status.conditionStatus string

Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]

Default value: StatusNotSet

Condition Status

status of the condition

status.lastUpdated date-time

Last Updated

when the condition status is last updated

status.reason string

Reason

reason of the last condition status

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

Default value: system.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: OrganizationList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
List of the resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the resource
kind Kindrequired
Default value: Organization
Kind of the resource
metadata objectrequired
Metadata of the 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
Spec of the resource
billingAddress Billing Address
Billing address of the organization
active Active
Represents if this organization is active
approved Approved
Is this organization active
type Type
Type of organization
addressLine1 Address Line 1
Address of the organization
addressLine2 Address Line 2
Address of the organization
city City
City
country Country
Country of the organization
phone Phone
Phone number of the organization
state State
State of the organization
zipcode Zipcode
Zipcode
isPrivate Is Private
Is Private Organization
isTotpEnabled Is TOTP Enabled
Is TOTP enabled at organization level
areClustersShared Clusters Shared
Are clusters shared
settings object
Various settings like lockout, auto-logout configuration
lockout object
Lockout settings of the organization
enabled Enabled
Is lockout settings enabled?
periodMin int32
Lockout period in Minutes
attempts int32
Max number of attempts before lockout
idleLogoutMin int32
Idle Logout time in minutes
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": "OrganizationList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "Organization",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "billingAddress": "string",
        "active": true,
        "approved": true,
        "type": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "phone": "string",
        "state": "string",
        "zipcode": "string",
        "isPrivate": true,
        "isTotpEnabled": true,
        "areClustersShared": true,
        "settings": {
          "lockout": {
            "enabled": true,
            "periodMin": 0,
            "attempts": 0
          },
          "idleLogoutMin": 0
        }
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.625Z",
        "reason": "string"
      }
    }
  ]
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: system.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: OrganizationList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
List of the resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the resource
kind Kindrequired
Default value: Organization
Kind of the resource
metadata objectrequired
Metadata of the 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
Spec of the resource
billingAddress Billing Address
Billing address of the organization
active Active
Represents if this organization is active
approved Approved
Is this organization active
type Type
Type of organization
addressLine1 Address Line 1
Address of the organization
addressLine2 Address Line 2
Address of the organization
city City
City
country Country
Country of the organization
phone Phone
Phone number of the organization
state State
State of the organization
zipcode Zipcode
Zipcode
isPrivate Is Private
Is Private Organization
isTotpEnabled Is TOTP Enabled
Is TOTP enabled at organization level
areClustersShared Clusters Shared
Are clusters shared
settings object
Various settings like lockout, auto-logout configuration
lockout object
Lockout settings of the organization
enabled Enabled
Is lockout settings enabled?
periodMin int32
Lockout period in Minutes
attempts int32
Max number of attempts before lockout
idleLogoutMin int32
Idle Logout time in minutes
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": "OrganizationList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "Organization",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "billingAddress": "string",
        "active": true,
        "approved": true,
        "type": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "phone": "string",
        "state": "string",
        "zipcode": "string",
        "isPrivate": true,
        "isTotpEnabled": true,
        "areClustersShared": true,
        "settings": {
          "lockout": {
            "enabled": true,
            "periodMin": 0,
            "attempts": 0
          },
          "idleLogoutMin": 0
        }
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.625Z",
        "reason": "string"
      }
    }
  ]
}

403

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