Start tenant onboarding

POST 
/sse/connector/v2.0/api/tenant:start-onboarding

Enable ZTNA Connector and starts the tenant on-boarding process. This API performs the same configuration as occurs when you click Enable ZTNA Connector in the UI.

Request

Responses

202

OK

application/json

Schema

Schema

msg string

Example (from schema)

{
  "msg": "string"
}

401

Unauthorized

application/json

Schema

Schema

error object
code number
Possible values: [16]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {
    "code": 16,
    "details": [
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {}
    ],
    "message": "string"
  }
}

not_authenticated

Not Authenticated

{
  "error": {
    "code": 16,
    "message": "Not Authenticated"
  }
}

token_expired

Token Expired

{
  "error": {
    "code": 16,
    "message": "Token Expired"
  }
}

Loading...