List allowed smart credential definitions
GET/api/web/v1/scdefns/users/:userId
List allowed smart credential definitions. Caller requires the SCDEFNS:VIEW permission.
Request
Path Parameters
The UUID of the user whose allowed smart credential definitions to be fetched.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
A flag indicating if smart credentials using this SC definition must have a card digital id config defined.
A flag indicating if smart credentials using this SC definition must have a card holder digital id config defined.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
Requirements for digits in card PINs for smart credentials for this SC Defn.
The length of card PINs generated for smart credentials for this SC Defn.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
Requirements for lowercase letters in card PINs for smart credentials for this SC Defn.
The maximum number of times a wrong PIN can be entered incorrectly before it locks out the smart credential.
The maximum PIN length of card PINs for smart credentials for this SC Defn.
The maximum number of times a PIN can be used before it must be changed after it is set by an administrator.
The minimum PIN length of card PINs for smart credentials for this SC Defn.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
Requirements for special characters in card PINs for smart credentials for this SC Defn.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
Requirements for uppercase letters in card PINs for smart credentials for this SC Defn.
The UUID of the default card digital id config. If not set, there is no default.
The UUID of the default card holder digital id config. If not set, there is no default.
A flag indicating if this is the default SC Defn.
The UUID of this SC Defn.
The lifetime of smart credentials created for this SC Defn.
The name of this SC Defn.
The UUID of the PIV applet configuration associated with this smart credential definition.
The UUID of the CA that defines the PIV Content Signer for this SC definition. If not set, the PIV Content Signer is derived from the digital id configs.
variables
object[]
Smart Credential Definition Variables defined for this SC Defn.
The default value of this variable.
A flag indicating if values for this variable should be displayed.
A flag indicating if the initial value for this variable should be generated.
A length value used when generating values for this variable.
The UUID of this SC Defn Variable.
A flag indicating if values for this variable can be modified.
The name of this SC Defn Variable.
A value that specifies the order of this variable with respect to the other variables in the SC Defn.
Optional prompt to be used when prompting for a value for this variable.
A flag indicating if a value is required for this variable.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
A value specifying restrictions on digits appearing in values of this variable.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
A value specifying restrictions on lowercase characters appearing in values of this variable.
A value indicating a maximum for values of this variable. How this is enforced depends on the variable type.
A value indicating a minimum for values of this variable. How this is enforced depends on the variable type.
A value specifying a regex that values of this variable must match.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
A value specifying restrictions on special characters appearing in values of this variable.
Possible values: [ALLOWED
, REQUIRED
, NOT_ALLOWED
, NOT_SET
]
A value specifying restrictions on uppercase characters appearing in values of this variable.
The UUID of the SC Defn that owns this variable definition.
Possible values: [STRING
, BOOLEAN
, INTEGER
, UUID
]
The type of this variable.
Possible values: [GLOBAL
, USER
, NONE
]
A flag indicating if values of this variable must be unique and if so within what scope.
A value that allows a variable to be defined unique in the scope of another variable.
[
{
"cardDigitalIdConfigRequired": true,
"cardHolderDigitalIdConfigRequired": true,
"cardPinDigits": "ALLOWED",
"cardPinLength": 0,
"cardPinLower": "ALLOWED",
"cardPinMaxAttempts": 0,
"cardPinMaxLength": 0,
"cardPinMaxUsesAfterAdminReset": 0,
"cardPinMinLength": 0,
"cardPinSpecial": "ALLOWED",
"cardPinUpper": "ALLOWED",
"defaultCardDigitalIdConfigId": "string",
"defaultCardHolderDigitalIdConfigId": "string",
"defaultSCDefn": true,
"id": "string",
"lifetime": 0,
"name": "string",
"pivAppletConfigId": "string",
"pivContentSignerCAId": "string",
"variables": [
{
"defaultValue": "string",
"displayable": true,
"generate": true,
"generateLength": 0,
"id": "string",
"modifiable": true,
"name": "string",
"order": 0,
"prompt": "string",
"required": true,
"restrictionDigits": "ALLOWED",
"restrictionLower": "ALLOWED",
"restrictionMax": 0,
"restrictionMin": 0,
"restrictionRegex": "string",
"restrictionSpecial": "ALLOWED",
"restrictionUpper": "ALLOWED",
"scDefnId": "string",
"type": "STRING",
"uniqueness": "GLOBAL",
"uniquenessScopeId": "string"
}
]
}
]
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}