FruxonDocs
UsersAuth

Gets authorization settings metadata for all supported auth types.

Returns the configuration parameters and their descriptions for each supported authorization type, used when creating or editing integrations.

GET
/v1/authMetadata:settings
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Response Body

curl -X GET "https://api.fruxon.com/v1/authMetadata:settings"
{
  "UNSPECIFIED": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "NONE": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "API_KEY": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "BEARER_TOKEN": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "BASIC_AUTH": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "O_AUTH2": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "CUSTOM": {
    "parametersMetadata": [
      {
        "name": "string",
        "index": 0,
        "type": "string",
        "typeName": "string",
        "integerRange": {
          "min": 0,
          "max": 0
        },
        "floatRange": {
          "min": 0.1,
          "max": 0.1
        },
        "options": [
          {
            "value": "string",
            "label": "string",
            "description": "string"
          }
        ],
        "asset": {
          "providers": [
            "string"
          ],
          "contentTypes": [
            "string"
          ],
          "vectorized": true
        },
        "displayName": "string",
        "description": "string",
        "required": true,
        "secret": true,
        "defaultValue": "string",
        "jsonSchema": {},
        "uiHint": "UNSPECIFIED",
        "rules": [
          {
            "effect": "UNSPECIFIED",
            "all": [
              {
                "sourceParam": "string",
                "operator": "UNSPECIFIED",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty