Jump to

• Request
• Response

Get Besu Client Credentials

get

/api/v1/besu/instance/{id}/client-credentials

Get the generated client credentials for a Besu instance.

Request

Path Parameters

• id(required): string
  Unique Besu instance identifier

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ClientCredentials

Type: object

Besu client credentials.

Show Source

• ACCESS_TOKEN_ENDPOINT: string
  OIDC token endpoint. Present only when IDENTITY_PROVIDER_TYPE is OIDC.
• CLIENT_ID(required): string
• CLIENT_SECRET(required): string
• IDENTITY_PROVIDER_TYPE(required): string
  Allowed Values: [ "LDAP", "OIDC" ]

  Identity-provider type used by the instance.

{
    "description":"Besu client credentials.",
    "type":"object",
    "required":[
        "CLIENT_ID",
        "CLIENT_SECRET",
        "IDENTITY_PROVIDER_TYPE"
    ],
    "properties":{
        "CLIENT_ID":{
            "type":"string"
        },
        "CLIENT_SECRET":{
            "type":"string"
        },
        "IDENTITY_PROVIDER_TYPE":{
            "type":"string",
            "enum":[
                "LDAP",
                "OIDC"
            ],
            "description":"Identity-provider type used by the instance."
        },
        "ACCESS_TOKEN_ENDPOINT":{
            "type":"string",
            "description":"OIDC token endpoint. Present only when IDENTITY_PROVIDER_TYPE is OIDC."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top