Management API Reference for credential

The credential used to communicate with the OpenID Connect provider.

Attributes (8)

algorithm - The credential signature algorithm used by the OpenID provider.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The credential signature algorithm used by the OpenID provider.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-key-alias - The client key alias when the credential provider is used.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The client key alias when the credential provider is used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-key-password - The password for the client key when the credential provider is used. This is required if 'client-keystore-file' has been specified.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for the client key when the credential provider is used. This is required if 'client-keystore-file' has been specified.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-keystore-file - The path to the client keystore when the credential provider is used. This is optional.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path to the client keystore when the credential provider is used. This is optional.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-keystore-password - The password for the client keystore when the credential provider is used. This is required if 'client-keystore-file' has been specified.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for the client keystore when the credential provider is used. This is required if 'client-keystore-file' has been specified.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-keystore-type - The client keystore type when the credential provider is used.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The client keystore type when the credential provider is used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

secret - The client secret that was registered with the OpenID provider.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The client secret that was registered with the OpenID provider.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

token-timeout - The amount of time after which the token expires and can no longer be used to authenticate requests.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The amount of time after which the token expires and can no longer be used to authenticate requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Add credentials used to communicate with the OpenID provider.

Request Parameter	Type	Required	Expressions Allowed	Description
algorithm	STRING	false	true	The credential signature algorithm used by the OpenID provider.
client-key-alias	STRING	false	true	The client key alias when the credential provider is used.
client-key-password	STRING	false	true	The password for the client key when the credential provider is used. This is required if 'client-keystore-file' has been specified.
client-keystore-file	STRING	false	true	The path to the client keystore when the credential provider is used. This is optional.
client-keystore-password	STRING	false	true	The password for the client keystore when the credential provider is used. This is required if 'client-keystore-file' has been specified.
client-keystore-type	STRING	false	true	The client keystore type when the credential provider is used.
secret	STRING	false	true	The client secret that was registered with the OpenID provider.
token-timeout	INT	false	true	The amount of time after which the token expires and can no longer be used to authenticate requests.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add credentials used to communicate with the OpenID provider.",
    "request-properties" : {
        "algorithm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The credential signature algorithm used by the OpenID provider.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-key-alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client key alias when the credential provider is used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-key-password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The password for the client key when the credential provider is used. This is required if 'client-keystore-file' has been specified.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-keystore-file" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path to the client keystore when the credential provider is used. This is optional.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-keystore-password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The password for the client keystore when the credential provider is used. This is required if 'client-keystore-file' has been specified.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-keystore-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client keystore type when the credential provider is used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "secret" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client secret that was registered with the OpenID provider.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "token-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The amount of time after which the token expires and can no longer be used to authenticate requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove the credentials used to communicate with the OpenID provider.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the credentials used to communicate with the OpenID provider.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.elytron-oidc-client.secure-deployment.credential

        
<feature spec="subsystem.elytron-oidc-client.secure-deployment.credential">
  <param name="credential" value="{resource name}"/>
  <param name="secure-deployment" value="{resource name}"/>
  <param name="algorithm" value="{value}"/>
  <param name="client-key-alias" value="{value}"/>
  <param name="client-key-password" value="{value}"/>
  <param name="client-keystore-file" value="{value}"/>
  <param name="client-keystore-password" value="{value}"/>
  <param name="client-keystore-type" value="{value}"/>
  <param name="secret" value="{value}"/>
  <param name="token-timeout" value="{value}"/>
<feature/>