Create Provider

Create Provider registers a new provider in Guardian. Once a provider config is registered, Guardian will immediately fetch the resources and store it in the database.

Query Parameters

dryRun boolean

application/json

Request Body required

type string
urn string
labels object
property name* string
credentials
appeal object
allowPermanentAccess boolean
allowActiveAccessExtensionIn string
resources object[]
Array [
type string
policy object
id string
version int32
roles object[]
Array [
id string
name string
description string
permissions undefined[]
]
filter string
]
allowedAccountTypes string[]
parameters object[]
Array [
key string
label string
required boolean
description string
]

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

provider object

id string

type string

urn string

config object

type string

urn string

labels object

property name* string

credentials

appeal object

allowPermanentAccess boolean

allowActiveAccessExtensionIn string

resources object[]

Array [

type string

policy object

id string

version int32

roles object[]

Array [

id string

name string

description string

permissions undefined[]

]

filter string

]

allowedAccountTypes string[]

parameters object[]

Array [

key string

label string

required boolean

description string

]

createdAt date-time

Creation time of the provider

updatedAt date-time

Last update time of the provider

{
  "provider": {
    "id": "string",
    "type": "string",
    "urn": "string",
    "config": {
      "type": "string",
      "urn": "string",
      "labels": {},
      "credentials": {},
      "appeal": {
        "allowPermanentAccess": true,
        "allowActiveAccessExtensionIn": "string"
      },
      "resources": [
        {
          "type": "string",
          "policy": {
            "id": "string",
            "version": 0
          },
          "roles": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "permissions": [
                null
              ]
            }
          ],
          "filter": "string"
        }
      ],
      "allowedAccountTypes": [
        "string"
      ],
      "parameters": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "description": "string"
        }
      ]
    },
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...