Install or request a Store server for a principal

POST

gateways

{gateway_id}

store

principal

installs

Error

A valid request URL is required to generate request examples

{
  "already_installed": true,
  "code": "<string>",
  "instance_choices": [
    {
      "name": "<string>",
      "registry_id": "<string>"
    }
  ],
  "instance_id": "<string>",
  "name": "<string>",
  "pending": true,
  "requires_admin_setup": true,
  "requires_auth": true,
  "requires_config": true,
  "requires_instance_choice": true,
  "requires_reason": true,
  "status": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

gateway_id

string<uuid>

required

Gateway id

Body

application/json

Who and what

code

string

groups

string[]

instance_id

string

principal_sub

string

reason

string

Reason is why the user wants the server, in their own words. Kept only on a request an approver has to decide, and shown to them there.

Response

already_installed

boolean

code

string

instance_choices

object[]

Show child attributes

instance_id

string

name

string

pending

boolean

requires_admin_setup

boolean

requires_auth

boolean

requires_config

boolean

requires_instance_choice

boolean

requires_reason

boolean

RequiresReason is an install the caller must ask about first: it is outside the user's access, so it files a request an approver decides on, and the requester's words are what they read. A caller whose view of the access level was stale asked for an install and gets this instead of a refusal.

status

string

Error

A valid request URL is required to generate request examples

{
  "already_installed": true,
  "code": "<string>",
  "instance_choices": [
    {
      "name": "<string>",
      "registry_id": "<string>"
    }
  ],
  "instance_id": "<string>",
  "name": "<string>",
  "pending": true,
  "requires_admin_setup": true,
  "requires_auth": true,
  "requires_config": true,
  "requires_instance_choice": true,
  "requires_reason": true,
  "status": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

TrustGate

TrustGuard

Authorizations

Path Parameters

Body

Response