PartnerService_GetPartner

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

PartnerService_GetPartner

Request

Path Parameters

metadata.name stringrequired

name of the resource

Query Parameters

apiVersion stringrequired

Default value: system.k8smgmt.io/v3

API Version

API Version of the resource

kind stringrequired

Default value: Partner

Kind

Kind 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.partner string

Partner

Partner to which the resource belongs

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

Host

Host of the partner

spec.domain string

Domain

Domain of the partner

spec.tosLink string

TOS

Terms of service url of the partner

spec.logoLink string

Logo

Logo url of the partner

spec.notificationEmail string

Notification Email

Notification email of the partner

spec.helpdeskEmail string

Helpdesk Email

Helpdesk email of the partner

spec.productName string

Product Name

Product Name

spec.supportTeamName string

Support Team Name

Support Team Name

spec.opsHost string

OPS Host

Operations host of the partner

spec.favIconLink string

Fav Icon Link

Fav Icon Link

spec.isTOTPEnabled boolean

TOTP Enabled

TOTP Enabled flag at the partner level

spec.settings object

Settings

Settings of the partner

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 Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the resource

kind Kindrequired

Default value: Partner

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

host Host

Host of the partner

domain Domain

Domain of the partner

tosLink TOS

Terms of service url of the partner

logoLink Logo

Logo url of the partner

notificationEmail Notification Email

Notification email of the partner

helpdeskEmail Helpdesk Email

Helpdesk email of the partner

productName Product Name

Product Name

supportTeamName Support Team Name

Support Team Name

opsHost OPS Host

Operations host of the partner

favIconLink Fav Icon Link

Fav Icon Link

isTOTPEnabled TOTP Enabled

TOTP Enabled flag at the partner level

settings object

Settings of the partner

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": "Partner",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "host": "string",
    "domain": "string",
    "tosLink": "string",
    "logoLink": "string",
    "notificationEmail": "string",
    "helpdeskEmail": "string",
    "productName": "string",
    "supportTeamName": "string",
    "opsHost": "string",
    "favIconLink": "string",
    "isTOTPEnabled": true,
    "settings": {}
  },
  "status": {
    "conditionType": "string",
    "conditionStatus": "StatusNotSet",
    "lastUpdated": "2024-02-15T00:40:10.662Z",
    "reason": "string"
  }
}

application/yaml

Schema

Schema

apiVersion API Versionrequired

Default value: system.k8smgmt.io/v3

API Version of the resource

kind Kindrequired

Default value: Partner

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

host Host

Host of the partner

domain Domain

Domain of the partner

tosLink TOS

Terms of service url of the partner

logoLink Logo

Logo url of the partner

notificationEmail Notification Email

Notification email of the partner

helpdeskEmail Helpdesk Email

Helpdesk email of the partner

productName Product Name

Product Name

supportTeamName Support Team Name

Support Team Name

opsHost OPS Host

Operations host of the partner

favIconLink Fav Icon Link

Fav Icon Link

isTOTPEnabled TOTP Enabled

TOTP Enabled flag at the partner level

settings object

Settings of the partner

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": "Partner",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "host": "string",
    "domain": "string",
    "tosLink": "string",
    "logoLink": "string",
    "notificationEmail": "string",
    "helpdeskEmail": "string",
    "productName": "string",
    "supportTeamName": "string",
    "opsHost": "string",
    "favIconLink": "string",
    "isTOTPEnabled": true,
    "settings": {}
  },
  "status": {
    "conditionType": "string",
    "conditionStatus": "StatusNotSet",
    "lastUpdated": "2024-02-15T00:40:10.663Z",
    "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...