List Providers

List Providers returns a list of providers supported by Guardian

Responses

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

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

providers object[]
Array [
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
]

{
  "providers": [
    {
      "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"
    }
  ]
}

GET /v1beta1/providers

Authorization

name: X-Auth-Emailtype: apiKeydescription: Email address of the userin: header

Request

Base URL

http://127.0.0.1:7400

apiKey

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'