Jump to

• Request
• Response

Get all AuthFunctionFamily objects by the list of ids.

put

https://{host}:{port}/{basePath}/AuthFunctionFamily/

get all AuthFunctionFamily objects by the list of ids.

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• GetAuthFunctionFamilyByIdsIdsParam: array GetAuthFunctionFamilyByIdsIdsParam
  List of ids to retrieve the associated AuthFunctionFamilys.

{
    "properties":{
        "GetAuthFunctionFamilyByIdsIdsParam":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of ids to retrieve the associated AuthFunctionFamilys."
        }
    }
}

Nested Schema : GetAuthFunctionFamilyByIdsIdsParam

Type: array

List of ids to retrieve the associated AuthFunctionFamilys.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of ids to retrieve the associated AuthFunctionFamilys."
}

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object AuthFunctionFamily

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuthFunctionFamily"
    }
}

Nested Schema : AuthFunctionFamily

Type: object

Show Source

• faultIds: array faultIds
• name(required): string
  Maximum Length: 128
• predefined: boolean
• resources(required): string
  Maximum Length: 4000

{
    "properties":{
        "name":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "resources":{
            "description":"",
            "maxLength":4000,
            "type":"string"
        },
        "predefined":{
            "description":"",
            "type":"boolean"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "name",
        "resources"
    ],
    "type":"object",
    "description":""
}

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top