repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
aquasecurity/trivy | 37da98df45f6014fcd5f1744e2e26351b61d2a02 | 2024-05-02T18:16:17 | pkg/iac/rego/schemas/dockerfile.json | 21,693 | 2024-05-29T14:26:03.633377Z | {
"$defs": {
"command": {
"properties": {
"Cmd": {
"type": "string"
},
"EndLine": {
"type": "integer"
},
"Flags": {
"items": {
"type": "string"
},
"type": "array"
},
"JSON": {
"type": "boolean"
},
"Original": {
"type": "string"
},
"Path": {
"type": "string"
},
"Stage": {
"type": "integer"
},
"StartLine": {
"type": "integer"
},
"SubCmd": {
"type": "string"
},
"Value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"stage": {
"properties": {
"Commands": {
"items": {
"$ref": "#/$defs/command"
},
"type": "array"
},
"Name": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/aquasecurity/trivy/blob/main/pkg/iac/rego/schemas/dockerfile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"Stages": {
"items": {
"$ref": "#/$defs/stage"
},
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
aquasecurity/trivy | 37da98df45f6014fcd5f1744e2e26351b61d2a02 | 2024-05-02T18:16:17 | pkg/iac/rego/schemas/kubernetes.json | 21,693 | 2024-05-29T14:26:03.633377Z | {
"$id": "https://github.com/aquasecurity/trivy/blob/main/pkg/iac/rego/schemas/kubernetes.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"type": "object"
},
"rules": {
"items": {
"properties": {
"apiGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"spec": {
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
aquasecurity/trivy | 14adbb446460bd2b93d1e9bfaad2238e2b1e1f83 | 2024-02-16T08:31:32 | pkg/iac/rego/schemas/rbac.json | 21,693 | 2024-05-29T14:26:03.633377Z | {
"$id": "https://github.com/aquasecurity/trivy-policies/blob/main/pkg/rego/schemas/rbac.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"type": "object"
},
"rules": {
"items": {
"properties": {
"apiGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"spec": {
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | a0b0afb6ec1ea8102943fdf68530b5f566de8971 | 2023-12-20T12:45:11 | app/Config/Schema/json/BulkLoadShell/schema.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Config/Schema/json/BulkLoadShell/schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"AdHocAttribute": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"org_identity_id": {
"type": "integer"
},
"tag": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"tag",
"value"
],
"type": "object"
},
"type": "array"
},
"Address": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"country": {
"type": "string"
},
"description": {
"type": "string"
},
"language": {
"type": "string"
},
"locality": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"postal_code": {
"type": "string"
},
"room": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"CoGroup": {
"additionalProperties": false,
"properties": {
"CoGroupMember": {
"$ref": "#/definitions/CoGroupMember"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"open": {
"type": "boolean"
},
"status": {
"type": "string"
}
},
"required": [
"name",
"status"
],
"type": "object"
},
"CoGroupMember": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"member": {
"type": "boolean"
},
"owner": {
"type": "boolean"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CoPerson": {
"additionalProperties": false,
"properties": {
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"Url": {
"$ref": "#/definitions/Url"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"status": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"CoPersonRole": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"affiliation": {
"type": "string"
},
"co_person_id": {
"type": "integer"
},
"cou_id": {
"type": "integer"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"sponsor_co_person_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"required": [
"affiliation",
"co_person_id",
"status"
],
"type": "object"
},
"type": "array"
},
"EmailAddress": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"mail": {
"format": "email",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"verified": {
"type": "string"
}
},
"required": [
"mail",
"type"
],
"type": "object"
},
"type": "array"
},
"HistoryRecord": {
"items": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"co_person_role_id": {
"type": "integer"
},
"comment": {
"format": "email",
"type": "string"
},
"org_identity_id": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"Identifier": {
"items": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"identifier": {
"format": "email",
"type": "string"
},
"login": {
"type": "boolean"
},
"org_identity_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"identifier",
"type",
"status"
],
"type": "object"
},
"type": "array"
},
"Name": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"family": {
"type": "string"
},
"given": {
"type": "string"
},
"honorific": {
"type": "string"
},
"language": {
"type": "string"
},
"middle": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"primary_name": {
"type": "boolean"
},
"suffix": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"given",
"type"
],
"type": "object"
},
"type": "array"
},
"OrgIdentities": {
"items": {
"$ref": "#/definitions/OrgIdentity"
},
"type": "array"
},
"OrgIdentity": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"Url": {
"$ref": "#/definitions/Url"
},
"affiliation": {
"type": "string"
},
"co_id": {
"type": "integer"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"OrgIdentitySourceRecord": {
"additionalProperties": false,
"properties": {
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentity"
},
"last_update": {
"format": "date",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"org_identity_source_id": {
"type": "integer"
},
"reference_identifier": {
"type": "string"
},
"sorid": {
"type": "string"
},
"source_record": {
"type": "string"
}
},
"required": [
"org_identity_source_id",
"sorid",
"last_update"
],
"type": "object"
},
"Url": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"type"
],
"type": "object"
},
"type": "array"
}
},
"description": "COmanage Registry BulkLoad Shell record format",
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"CoGroup": {
"$ref": "#/definitions/CoGroup"
},
"CoGroupMember": {
"$ref": "#/definitions/CoGroupMember"
},
"CoPerson": {
"$ref": "#/definitions/CoPerson"
},
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"OrgIdentitySourceRecord": {
"$ref": "#/definitions/OrgIdentitySourceRecord"
},
"Url": {
"$ref": "#/definitions/Url"
},
"meta": {
"additionalProperties": false,
"properties": {
"local": {
"description": "Additional site specific information may be encoded here",
"type": "object"
},
"objectType": {
"description": "Indicator of the primary object type for this record",
"enum": [
"CoGroup",
"CoPerson"
],
"type": "string"
},
"xref": {
"description": "Cross Reference label that can be used to lookup the new object ID assigned to this primary object",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
"type": "object"
}
},
"title": "COmanage Registry BulkLoad Shell",
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | 0337c6eee36bc23b9586e51e869e59d9d51c4d40 | 2021-01-02T14:50:52 | app/Config/Schema/json/BulkLoadShell/schema.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Config/Schema/json/BulkLoadShell/schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"AdHocAttribute": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"org_identity_id": {
"type": "integer"
},
"tag": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"tag",
"value"
],
"type": "object"
},
"type": "array"
},
"Address": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"country": {
"type": "string"
},
"description": {
"type": "string"
},
"language": {
"type": "string"
},
"locality": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"postal_code": {
"type": "string"
},
"room": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"CoGroup": {
"additionalProperties": false,
"properties": {
"CoGroupMember": {
"$ref": "#/definitions/CoGroup"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"open": {
"type": "boolean"
},
"status": {
"type": "string"
}
},
"required": [
"name",
"status"
],
"type": "object"
},
"CoGroupMember": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"member": {
"type": "boolean"
},
"owner": {
"type": "boolean"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CoPerson": {
"additionalProperties": false,
"properties": {
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"Url": {
"$ref": "#/definitions/Url"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"status": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"CoPersonRole": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"affiliation": {
"type": "string"
},
"co_person_id": {
"type": "integer"
},
"cou_id": {
"type": "integer"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"sponsor_co_person_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"required": [
"affiliation",
"co_person_id",
"status"
],
"type": "object"
},
"type": "array"
},
"EmailAddress": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"mail": {
"format": "email",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"verified": {
"type": "string"
}
},
"required": [
"mail",
"type"
],
"type": "object"
},
"type": "array"
},
"HistoryRecord": {
"items": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"co_person_role_id": {
"type": "integer"
},
"comment": {
"format": "email",
"type": "string"
},
"org_identity_id": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"Identifier": {
"items": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"identifier": {
"format": "email",
"type": "string"
},
"login": {
"type": "boolean"
},
"org_identity_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"identifier",
"type",
"status"
],
"type": "object"
},
"type": "array"
},
"Name": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"family": {
"type": "string"
},
"given": {
"type": "string"
},
"honorific": {
"type": "string"
},
"language": {
"type": "string"
},
"middle": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"primary_name": {
"type": "boolean"
},
"suffix": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"given",
"type"
],
"type": "object"
},
"type": "array"
},
"OrgIdentities": {
"items": {
"$ref": "#/definitions/OrgIdentity"
},
"type": "array"
},
"OrgIdentity": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"Url": {
"$ref": "#/definitions/Url"
},
"affiliation": {
"type": "string"
},
"co_id": {
"type": "integer"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"OrgIdentitySourceRecord": {
"additionalProperties": false,
"properties": {
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentity"
},
"last_update": {
"format": "date",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"org_identity_source_id": {
"type": "integer"
},
"reference_identifier": {
"type": "string"
},
"sorid": {
"type": "string"
},
"source_record": {
"type": "string"
}
},
"required": [
"org_identity_source_id",
"sorid",
"last_update"
],
"type": "object"
},
"Url": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"type"
],
"type": "object"
},
"type": "array"
}
},
"description": "COmanage Registry BulkLoad Shell record format",
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"CoGroup": {
"$ref": "#/definitions/CoGroup"
},
"CoGroupMember": {
"$ref": "#/definitions/CoGroupMember"
},
"CoPerson": {
"$ref": "#/definitions/CoPerson"
},
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"OrgIdentitySourceRecord": {
"$ref": "#/definitions/OrgIdentitySourceRecord"
},
"Url": {
"$ref": "#/definitions/Url"
},
"meta": {
"additionalProperties": false,
"properties": {
"local": {
"description": "Additional site specific information may be encoded here",
"type": "object"
},
"objectType": {
"description": "Indicator of the primary object type for this record",
"enum": [
"CoGroup",
"CoPerson"
],
"type": "string"
},
"xref": {
"description": "Cross Reference label that can be used to lookup the new object ID assigned to this primary object",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
"type": "object"
}
},
"title": "COmanage Registry BulkLoad Shell",
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | 0337c6eee36bc23b9586e51e869e59d9d51c4d40 | 2021-01-02T14:50:52 | app/Config/Schema/json/BulkLoadShell/meta-schema.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Config/Schema/json/BulkLoadShell/meta-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "COmanage Registry BulkLoad Shell metadata",
"properties": {
"meta": {
"additionalProperties": false,
"description": "BulkLoad Shell metadata",
"properties": {
"local": {
"description": "Additional site specific information may be encoded here",
"type": "object"
},
"pluginModels": {
"properties": {
"CoGroup": {
"items": {
"type": "string"
},
"type": "array"
},
"CoPerson": {
"items": {
"type": "string"
},
"type": "array"
},
"Configuration": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "COmanage Registry BulkLoad Shell Metadata Object",
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | 54fc2e0d39a4c28890a54205cd829294286ca844 | 2021-05-28T17:51:43 | app/Plugin/CoreApi/Config/Schema/message.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Plugin/CoreApi/Config/Schema/message.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"Certificate": {
"items": {
"additionalProperties": false,
"properties": {
"certificate_authenticator_id": {
"description": "Certificate Authenticator ID associated with this Certificate",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "Description of this Certificate",
"type": "string"
},
"issuer_in": {
"description": "Issuer DN of this Certificate",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"subject_dn": {
"description": "Subject DN of this Certificate",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Certificate",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Certificate",
"format": "date-time",
"type": "string"
}
},
"required": [
"subject_dn"
],
"type": "object"
},
"type": "array"
},
"Password": {
"items": {
"additionalProperties": false,
"properties": {
"meta": {
"$ref": "#/definitions/meta"
},
"password": {
"description": "Password",
"type": "string"
},
"password_authenticator_id": {
"description": "Password Authenticator ID associated with this Password",
"readOnly": true,
"type": "integer"
},
"password_type": {
"description": "Password (hash) type",
"type": "string"
}
},
"required": [
"password",
"password_type "
],
"type": "object"
},
"type": "array"
},
"SshKey": {
"items": {
"additionalProperties": false,
"properties": {
"comment": {
"description": "Comment for this SSH Key",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"skey": {
"description": "SSH Key",
"type": "string"
},
"ssh_key_authenticator_id": {
"description": "SSH Key Authenticator ID associated with this SSH Key",
"readOnly": true,
"type": "integer"
},
"type": {
"description": "SSH Key type",
"type": "string"
}
},
"required": [
"type",
"skey"
],
"type": "object"
},
"type": "array"
},
"UnixClusterAccount": {
"items": {
"additionalProperties": false,
"properties": {
"gecos": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"home_directory": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"login_shell": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"primary_co_group_id": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"status": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"sync_mode": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"uid": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"unix_cluster_id": {
"description": "Unix Cluster ID associated with this Unix Cluster Account",
"readOnly": true,
"type": "integer"
},
"username": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Unix Cluster Account",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Unix Cluster Account",
"format": "date-time",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"definitions": {
"meta": {
"additionalProperties": false,
"patternProperties": {
"^source_.*_id$": {
"description": "The source for this record, if created via Pipeline",
"readOnly": true,
"type": "integer"
},
"_id$": {
"description": "Object parent key, for ChangelogBehavior",
"readOnly": true,
"type": "integer"
}
},
"properties": {
"actor_identifier": {
"description": "The identifier for the actor who last modified this object",
"readOnly": true,
"type": "string"
},
"created": {
"description": "When this object was originally created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deleted": {
"description": "Whether this object has been deleted",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "COmanage identifier for this object",
"readOnly": true,
"type": "integer"
},
"modified": {
"description": "When this object was last modified",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"revision": {
"description": "The revision number for this object",
"minimum": 0,
"readOnly": true,
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
}
},
"description": "COmanage Core API Message Format",
"properties": {
"CoGroupMember": {
"items": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"description": "CO Group ID for this membership",
"readOnly": true,
"type": "integer"
},
"co_group_nesting_id": {
"description": "CO Group Nesting that created this membership, if set",
"readOnly": true,
"type": "integer"
},
"member": {
"description": "If this CO Person is a member of this group",
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/meta"
},
"owner": {
"description": "If this CO Person is an owner of this group",
"type": "boolean"
}
},
"required": [
"co_group_id"
],
"type": "object"
},
"type": "array"
},
"CoPerson": {
"additionalProperties": false,
"properties": {
"co_id": {
"description": "CO ID for this CO Person",
"readOnly": true,
"type": "integer"
},
"date_of_birth": {
"description": "CO Person date of birth",
"format": "date",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"status": {
"description": "CO Person status",
"type": "string"
},
"timezone": {
"description": "Preferred timezone of this CO Person, for UI purposes",
"type": "string"
}
},
"required": [
"co_id",
"status"
],
"type": "object"
},
"CoPersonRole": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"items": {
"additionalProperties": false,
"properties": {
"meta": {
"$ref": "#/definitions/meta"
},
"tag": {
"description": "Tag for this Ad Hoc Attribute",
"type": "string"
},
"value": {
"description": "Value of this Ad Hoc Attribute",
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"type": "array"
},
"Address": {
"items": {
"additionalProperties": false,
"properties": {
"country": {
"description": "Country for this Address",
"type": "string"
},
"description": {
"description": "Description of this Address",
"type": "string"
},
"language": {
"description": "Language encoding of this Address",
"type": "string"
},
"locality": {
"description": "Locality (eg: city) of this Address",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"postal_code": {
"description": "Postal code of this Address",
"type": "string"
},
"room": {
"description": "Room associated with this Address",
"type": "string"
},
"state": {
"description": "State of this Address",
"type": "string"
},
"street": {
"description": "Street of this Address",
"type": "string"
},
"type": {
"description": "Type of this Address",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"TelephoneNumber": {
"items": {
"additionalProperties": false,
"properties": {
"area_code": {
"description": "Area code for this Telephone Number",
"type": "string"
},
"country_code": {
"description": "Country code for this Telephone Number",
"type": "string"
},
"description": {
"description": "Description of this Telephone Number",
"type": "string"
},
"extension": {
"description": "Extension for this Telephone Number",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"number": {
"description": "Number for this Telephone Number",
"type": "string"
},
"type": {
"description": "Type of this Telephone Number",
"type": "string"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"affiliation": {
"description": "CO Person Role affiliation",
"type": "string"
},
"cou_id": {
"description": "COU for this Role",
"type": "integer"
},
"meta": {
"$ref": "#/definitions/meta"
},
"o": {
"description": "Organization for this Role",
"type": "string"
},
"ordr": {
"description": "Order of this Role, relative to other roles for this person",
"type": "integer"
},
"ou": {
"description": "Department for this Role",
"type": "string"
},
"sponsor_co_person_id": {
"description": "CO Person ID of the sponsor for this Role",
"type": "integer"
},
"status": {
"description": "CO Person Role status",
"type": "string"
},
"title": {
"description": "Title for this Role",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Role",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Role",
"format": "date-time",
"type": "string"
}
},
"required": [
"affiliation",
"status"
],
"type": "object"
},
"type": "array"
},
"EmailAddress": {
"items": {
"additionalProperties": false,
"properties": {
"mail": {
"description": "An email address for this person",
"format": "email",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"type": {
"description": "The type of Email Address",
"type": "string"
},
"verified": {
"description": "Whether this Email Address has been verified",
"type": "boolean"
}
},
"required": [
"mail"
],
"type": "object"
},
"type": "array"
},
"Identifier": {
"items": {
"additionalProperties": false,
"properties": {
"identifier": {
"description": "A identifier for the person",
"type": "string"
},
"login": {
"description": "Whether this Identifier can be used to login to Registry",
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/meta"
},
"status": {
"description": "Identifier status",
"type": "string"
},
"type": {
"description": "The type of Identifier",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"type": "array"
},
"Name": {
"items": {
"additionalProperties": false,
"properties": {
"family": {
"description": "The family or surname",
"type": "string"
},
"formatted": {
"description": "The fully formatted name",
"type": "string"
},
"given": {
"description": "The given or first name",
"type": "string"
},
"language": {
"description": "The language encoding for this Name",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"middle": {
"description": "The middle name",
"type": "string"
},
"prefix": {
"description": "The honorific or prefix for the Name",
"type": "string"
},
"primary_name": {
"description": "Whether this is the primary Name",
"type": "boolean"
},
"suffix": {
"description": "The suffix for this Name",
"type": "string"
},
"type": {
"description": "The type of Name",
"type": "string"
}
},
"required": [
"given"
],
"type": "object"
},
"type": "array"
},
"OrgIdentity": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/properties/CoPersonRole/items/properties/AdHocAttribute"
},
"Address": {
"$ref": "#/properties/CoPersonRole/items/properties/Address"
},
"EmailAddress": {
"$ref": "#/properties/EmailAddress"
},
"Identifier": {
"$ref": "#/properties/Identifier"
},
"Name": {
"$ref": "#/properties/Name"
},
"TelephoneNumber": {
"$ref": "#/properties/CoPersonRole/items/properties/TelephoneNumber"
},
"Url": {
"$ref": "#/properties/Url"
},
"affiliation": {
"description": "Org Identity affiliation",
"type": "string"
},
"co_id": {
"description": "CO for this Org Identity",
"type": "integer"
},
"date_of_birth": {
"description": "Org Identity date of birth",
"format": "date",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"o": {
"description": "Organization for this Org Identity",
"type": "string"
},
"ou": {
"description": "Department for this Org Identity",
"type": "string"
},
"status": {
"description": "Org Identity status",
"type": "string"
},
"title": {
"description": "Title for this Org Identity",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Org Identity",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Org Identity",
"format": "date-time",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"Url": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of this URL",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"type": {
"description": "The type of URL",
"type": "string"
},
"url": {
"description": "A URL",
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"CoPerson"
],
"title": "COmanage Core API Message Format",
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | e9b5f9b0e95116cb9ea3223a4b86c007dfeff7c3 | 2024-02-27T21:47:26 | app/Config/Schema/json/BulkLoadShell/schema.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Config/Schema/json/BulkLoadShell/schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"AdHocAttribute": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"org_identity_id": {
"type": "integer"
},
"tag": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"tag",
"value"
],
"type": "object"
},
"type": "array"
},
"Address": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_role_id": {
"type": "integer"
},
"country": {
"type": "string"
},
"description": {
"type": "string"
},
"language": {
"type": "string"
},
"locality": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"postal_code": {
"type": "string"
},
"room": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"CoGroup": {
"additionalProperties": false,
"properties": {
"CoGroupMember": {
"$ref": "#/definitions/CoGroupMember"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"open": {
"type": "boolean"
},
"status": {
"type": "string"
}
},
"required": [
"name",
"status"
],
"type": "object"
},
"CoGroupMember": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"member": {
"type": "boolean"
},
"owner": {
"type": "boolean"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CoPerson": {
"additionalProperties": false,
"properties": {
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"Url": {
"$ref": "#/definitions/Url"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"status": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"CoPersonRole": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"affiliation": {
"type": "string"
},
"co_person_id": {
"type": "integer"
},
"cou_id": {
"type": "integer"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"sponsor_co_person_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"required": [
"affiliation",
"co_person_id",
"status"
],
"type": "object"
},
"type": "array"
},
"EmailAddress": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"mail": {
"format": "email",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"verified": {
"type": "string"
}
},
"required": [
"mail",
"type"
],
"type": "object"
},
"type": "array"
},
"HistoryRecord": {
"items": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"co_person_role_id": {
"type": "integer"
},
"comment": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"Identifier": {
"items": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"type": "integer"
},
"co_person_id": {
"type": "integer"
},
"identifier": {
"minLength": 1,
"type": "string"
},
"login": {
"type": "boolean"
},
"org_identity_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"identifier",
"type",
"status"
],
"type": "object"
},
"type": "array"
},
"Name": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"family": {
"type": "string"
},
"given": {
"type": "string"
},
"honorific": {
"type": "string"
},
"language": {
"type": "string"
},
"middle": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"primary_name": {
"type": "boolean"
},
"suffix": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"given",
"type"
],
"type": "object"
},
"type": "array"
},
"OrgIdentities": {
"items": {
"$ref": "#/definitions/OrgIdentity"
},
"type": "array"
},
"OrgIdentity": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"Url": {
"$ref": "#/definitions/Url"
},
"affiliation": {
"type": "string"
},
"co_id": {
"type": "integer"
},
"date_of_birth": {
"format": "date",
"type": "string"
},
"o": {
"type": "string"
},
"ordr": {
"type": "integer"
},
"ou": {
"type": "string"
},
"title": {
"type": "string"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_through": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"OrgIdentitySourceRecord": {
"additionalProperties": false,
"properties": {
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentity"
},
"last_update": {
"format": "date-time",
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"org_identity_source_id": {
"type": "integer"
},
"reference_identifier": {
"type": "string"
},
"sorid": {
"type": "string"
},
"source_record": {
"type": "string"
}
},
"required": [
"org_identity_source_id",
"sorid",
"last_update"
],
"type": "object"
},
"Url": {
"items": {
"additionalProperties": false,
"properties": {
"co_person_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"org_identity_id": {
"type": "integer"
},
"type": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"type"
],
"type": "object"
},
"type": "array"
}
},
"description": "COmanage Registry BulkLoad Shell record format",
"properties": {
"AdHocAttribute": {
"$ref": "#/definitions/AdHocAttribute"
},
"Address": {
"$ref": "#/definitions/Address"
},
"CoGroup": {
"$ref": "#/definitions/CoGroup"
},
"CoGroupMember": {
"$ref": "#/definitions/CoGroupMember"
},
"CoPerson": {
"$ref": "#/definitions/CoPerson"
},
"CoPersonRole": {
"$ref": "#/definitions/CoPersonRole"
},
"EmailAddress": {
"$ref": "#/definitions/EmailAddress"
},
"HistoryRecord": {
"$ref": "#/definitions/HistoryRecord"
},
"Identifier": {
"$ref": "#/definitions/Identifier"
},
"Name": {
"$ref": "#/definitions/Name"
},
"OrgIdentity": {
"$ref": "#/definitions/OrgIdentities"
},
"OrgIdentitySourceRecord": {
"$ref": "#/definitions/OrgIdentitySourceRecord"
},
"Url": {
"$ref": "#/definitions/Url"
},
"meta": {
"additionalProperties": false,
"properties": {
"local": {
"description": "Additional site specific information may be encoded here",
"type": "object"
},
"objectType": {
"description": "Indicator of the primary object type for this record",
"enum": [
"CoGroup",
"CoPerson"
],
"type": "string"
},
"xref": {
"description": "Cross Reference label that can be used to lookup the new object ID assigned to this primary object",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
"type": "object"
}
},
"title": "COmanage Registry BulkLoad Shell",
"type": "object"
} | Apache-2.0 | en |
Internet2/comanage-registry | c415f90ba1e99076b2de5cb54fbc5845f8b3a408 | 2023-06-19T15:38:45 | app/Plugin/CoreApi/Config/Schema/message.json | 16 | 2024-05-29T12:33:22.53656Z | {
"$id": "https://github.com/Internet2/comanage-registry/tree/4.0.0/app/Plugin/CoreApi/Config/Schema/message.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"Certificate": {
"items": {
"additionalProperties": false,
"properties": {
"certificate_authenticator_id": {
"description": "Certificate Authenticator ID associated with this Certificate",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "Description of this Certificate",
"type": "string"
},
"issuer_in": {
"description": "Issuer DN of this Certificate",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"subject_dn": {
"description": "Subject DN of this Certificate",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Certificate",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Certificate",
"format": "date-time",
"type": "string"
}
},
"required": [
"subject_dn"
],
"type": "object"
},
"type": "array"
},
"Password": {
"items": {
"additionalProperties": false,
"properties": {
"meta": {
"$ref": "#/definitions/meta"
},
"password": {
"description": "Password",
"type": "string"
},
"password_authenticator_id": {
"description": "Password Authenticator ID associated with this Password",
"readOnly": true,
"type": "integer"
},
"password_type": {
"description": "Password (hash) type",
"type": "string"
}
},
"required": [
"password",
"password_type "
],
"type": "object"
},
"type": "array"
},
"SshKey": {
"items": {
"additionalProperties": false,
"properties": {
"comment": {
"description": "Comment for this SSH Key",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"skey": {
"description": "SSH Key",
"type": "string"
},
"ssh_key_authenticator_id": {
"description": "SSH Key Authenticator ID associated with this SSH Key",
"readOnly": true,
"type": "integer"
},
"type": {
"description": "SSH Key type",
"type": "string"
}
},
"required": [
"type",
"skey"
],
"type": "object"
},
"type": "array"
},
"UnixClusterAccount": {
"items": {
"additionalProperties": false,
"properties": {
"gecos": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"home_directory": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"login_shell": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"primary_co_group_id": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"status": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"sync_mode": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"uid": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"unix_cluster_id": {
"description": "Unix Cluster ID associated with this Unix Cluster Account",
"readOnly": true,
"type": "integer"
},
"username": {
"description": "Sync Mode for this Unix Cluster Account",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Unix Cluster Account",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Unix Cluster Account",
"format": "date-time",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"definitions": {
"meta": {
"additionalProperties": false,
"patternProperties": {
"^source_.*_id$": {
"description": "The source for this record, if created via Pipeline",
"readOnly": true,
"type": "integer"
},
"_id$": {
"description": "Object parent key, for ChangelogBehavior",
"readOnly": true,
"type": "integer"
}
},
"properties": {
"actor_identifier": {
"description": "The identifier for the actor who last modified this object",
"readOnly": true,
"type": "string"
},
"created": {
"description": "When this object was originally created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deleted": {
"description": "Whether this object has been deleted",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "COmanage identifier for this object",
"readOnly": true,
"type": "integer"
},
"modified": {
"description": "When this object was last modified",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"revision": {
"description": "The revision number for this object",
"minimum": 0,
"readOnly": true,
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
}
},
"description": "COmanage Core API Message Format",
"properties": {
"CoDepartment": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/properties/CoPersonRole/items/properties/AdHocAttribute"
},
"Address": {
"$ref": "#/properties/CoPersonRole/items/properties/Address"
},
"EmailAddress": {
"$ref": "#/properties/EmailAddress"
},
"Identifier": {
"$ref": "#/properties/Identifier"
},
"TelephoneNumber": {
"$ref": "#/properties/CoPersonRole/items/properties/TelephoneNumber"
},
"Url": {
"$ref": "#/properties/Url"
},
"administrative_co_group_id": {
"description": "Administrative Group for this Department",
"type": "integer"
},
"co_id": {
"description": "CO for this Department",
"type": "integer"
},
"cou_id": {
"description": "COU for this Department",
"type": "integer"
},
"introduction": {
"description": "Introduction for this Department",
"type": "string"
},
"leadership_co_group_id": {
"description": "Leadership Group for this Department",
"type": "integer"
},
"meta": {
"$ref": "#/definitions/meta"
},
"name": {
"description": "Name for this Department",
"type": "string"
},
"support_co_group_id": {
"description": "Support Group for this Department",
"type": "integer"
},
"type": {
"description": "Type for this Department",
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"CoGroupMember": {
"items": {
"additionalProperties": false,
"properties": {
"co_group_id": {
"description": "CO Group ID for this membership",
"readOnly": true,
"type": "integer"
},
"co_group_nesting_id": {
"description": "CO Group Nesting that created this membership, if set",
"readOnly": true,
"type": "integer"
},
"member": {
"description": "If this CO Person is a member of this group",
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/meta"
},
"owner": {
"description": "If this CO Person is an owner of this group",
"type": "boolean"
}
},
"required": [
"co_group_id"
],
"type": "object"
},
"type": "array"
},
"CoPerson": {
"additionalProperties": false,
"properties": {
"co_id": {
"description": "CO ID for this CO Person",
"readOnly": true,
"type": "integer"
},
"date_of_birth": {
"description": "CO Person date of birth",
"format": "date",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"status": {
"description": "CO Person status",
"type": "string"
},
"timezone": {
"description": "Preferred timezone of this CO Person, for UI purposes",
"type": "string"
}
},
"required": [
"co_id",
"status"
],
"type": "object"
},
"CoPersonRole": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"items": {
"additionalProperties": false,
"properties": {
"meta": {
"$ref": "#/definitions/meta"
},
"tag": {
"description": "Tag for this Ad Hoc Attribute",
"type": "string"
},
"value": {
"description": "Value of this Ad Hoc Attribute",
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"type": "array"
},
"Address": {
"items": {
"additionalProperties": false,
"properties": {
"country": {
"description": "Country for this Address",
"type": "string"
},
"description": {
"description": "Description of this Address",
"type": "string"
},
"language": {
"description": "Language encoding of this Address",
"type": "string"
},
"locality": {
"description": "Locality (eg: city) of this Address",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"postal_code": {
"description": "Postal code of this Address",
"type": "string"
},
"room": {
"description": "Room associated with this Address",
"type": "string"
},
"state": {
"description": "State of this Address",
"type": "string"
},
"street": {
"description": "Street of this Address",
"type": "string"
},
"type": {
"description": "Type of this Address",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"TelephoneNumber": {
"items": {
"additionalProperties": false,
"properties": {
"area_code": {
"description": "Area code for this Telephone Number",
"type": "string"
},
"country_code": {
"description": "Country code for this Telephone Number",
"type": "string"
},
"description": {
"description": "Description of this Telephone Number",
"type": "string"
},
"extension": {
"description": "Extension for this Telephone Number",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"number": {
"description": "Number for this Telephone Number",
"type": "string"
},
"type": {
"description": "Type of this Telephone Number",
"type": "string"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"affiliation": {
"description": "CO Person Role affiliation",
"type": "string"
},
"cou_id": {
"description": "COU for this Role",
"type": "integer"
},
"meta": {
"$ref": "#/definitions/meta"
},
"o": {
"description": "Organization for this Role",
"type": "string"
},
"ordr": {
"description": "Order of this Role, relative to other roles for this person",
"type": "integer"
},
"ou": {
"description": "Department for this Role",
"type": "string"
},
"sponsor_co_person_id": {
"description": "CO Person ID of the sponsor for this Role",
"type": "integer"
},
"status": {
"description": "CO Person Role status",
"type": "string"
},
"title": {
"description": "Title for this Role",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Role",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Role",
"format": "date-time",
"type": "string"
}
},
"required": [
"affiliation",
"status"
],
"type": "object"
},
"type": "array"
},
"EmailAddress": {
"items": {
"additionalProperties": false,
"properties": {
"mail": {
"description": "An email address for this person",
"format": "email",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"type": {
"description": "The type of Email Address",
"type": "string"
},
"verified": {
"description": "Whether this Email Address has been verified",
"type": "boolean"
}
},
"required": [
"mail"
],
"type": "object"
},
"type": "array"
},
"Identifier": {
"items": {
"additionalProperties": false,
"properties": {
"identifier": {
"description": "A identifier for the person",
"type": "string"
},
"login": {
"description": "Whether this Identifier can be used to login to Registry",
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/meta"
},
"status": {
"description": "Identifier status",
"type": "string"
},
"type": {
"description": "The type of Identifier",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"type": "array"
},
"Name": {
"items": {
"additionalProperties": false,
"properties": {
"family": {
"description": "The family or surname",
"type": "string"
},
"formatted": {
"description": "The fully formatted name",
"type": "string"
},
"given": {
"description": "The given or first name",
"type": "string"
},
"language": {
"description": "The language encoding for this Name",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"middle": {
"description": "The middle name",
"type": "string"
},
"prefix": {
"description": "The honorific or prefix for the Name",
"type": "string"
},
"primary_name": {
"description": "Whether this is the primary Name",
"type": "boolean"
},
"suffix": {
"description": "The suffix for this Name",
"type": "string"
},
"type": {
"description": "The type of Name",
"type": "string"
}
},
"required": [
"given"
],
"type": "object"
},
"type": "array"
},
"OrgIdentity": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/properties/CoPersonRole/items/properties/AdHocAttribute"
},
"Address": {
"$ref": "#/properties/CoPersonRole/items/properties/Address"
},
"EmailAddress": {
"$ref": "#/properties/EmailAddress"
},
"Identifier": {
"$ref": "#/properties/Identifier"
},
"Name": {
"$ref": "#/properties/Name"
},
"TelephoneNumber": {
"$ref": "#/properties/CoPersonRole/items/properties/TelephoneNumber"
},
"Url": {
"$ref": "#/properties/Url"
},
"affiliation": {
"description": "Org Identity affiliation",
"type": "string"
},
"co_id": {
"description": "CO for this Org Identity",
"type": "integer"
},
"date_of_birth": {
"description": "Org Identity date of birth",
"format": "date",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"o": {
"description": "Organization for this Org Identity",
"type": "string"
},
"ou": {
"description": "Department for this Org Identity",
"type": "string"
},
"status": {
"description": "Org Identity status",
"type": "string"
},
"title": {
"description": "Title for this Org Identity",
"type": "string"
},
"valid_from": {
"description": "Valid from time for this Org Identity",
"format": "date-time",
"type": "string"
},
"valid_through": {
"description": "Valid through time for this Org Identity",
"format": "date-time",
"type": "string"
}
},
"required": [],
"type": "object"
},
"type": "array"
},
"Organization": {
"items": {
"additionalProperties": false,
"properties": {
"AdHocAttribute": {
"$ref": "#/properties/CoPersonRole/items/properties/AdHocAttribute"
},
"Address": {
"$ref": "#/properties/CoPersonRole/items/properties/Address"
},
"EmailAddress": {
"$ref": "#/properties/EmailAddress"
},
"Identifier": {
"$ref": "#/properties/Identifier"
},
"TelephoneNumber": {
"$ref": "#/properties/CoPersonRole/items/properties/TelephoneNumber"
},
"Url": {
"$ref": "#/properties/Url"
},
"co_id": {
"description": "CO for this Organization",
"type": "integer"
},
"description": {
"description": "Description for this Organization",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"name": {
"description": "Name for this Organization",
"type": "string"
},
"type": {
"description": "Type for this Organization",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"Url": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of this URL",
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"type": {
"description": "The type of URL",
"type": "string"
},
"url": {
"description": "A URL",
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"CoPerson"
],
"title": "COmanage Core API Message Format",
"type": "object"
} | Apache-2.0 | en |
Exit-9B/CraftingCategories | ddf773601c59d1f68d53c083eb044d43b2c6ac01 | 2022-12-26T18:37:38 | docs/CraftingCategories.schema.json | 5 | 2024-05-27T07:08:32.505559Z | {
"$defs": {
"category": {
"properties": {
"keywords": {
"description": "Keywords which will assign items to this category if present",
"items": {
"description": "Keyword EditorID",
"type": "string"
},
"type": "array"
},
"section": {
"description": "The parent section which the category is nested under",
"type": "string"
}
},
"required": [
"section"
],
"type": "object"
},
"section": {
"properties": {
"icon": {
"description": "Specifies an icon to appear next to the section label",
"properties": {
"label": {
"description": "Frame label in the timeline to display",
"type": "string"
},
"source": {
"default": "craftingcategories/icons.swf",
"description": "Path to a SWF movie in the Interface directory containing icons",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"keywords": {
"description": "Keywords which will assign items to this section if present",
"items": {
"description": "Keyword EditorID",
"type": "string"
},
"type": "array"
},
"priority": {
"default": 50,
"description": "Global priority (0-100) which controls order relative to other sections",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/Exit-9B/CraftingCategories/main/docs/CraftingCategories.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines categories for the Constructible Object menu",
"properties": {
"categories": {
"description": "Defines sub-categories within sections",
"patternProperties": {
"^[^\\$]": {
"$ref": "#/$defs/category",
"deprecated": true,
"description": "WARNING: String will not be localized"
},
"^\\$": {
"$ref": "#/$defs/category",
"description": "Defines a sub-category within a section"
}
},
"type": "object"
},
"sections": {
"description": "Defines top-level sections",
"patternProperties": {
"^[^\\$]": {
"$ref": "#/$defs/section",
"deprecated": true,
"description": "WARNING: String will not be localized"
},
"^\\$": {
"$ref": "#/$defs/section",
"description": "Defines a top-level section"
}
},
"type": "object"
}
},
"title": "Crafting Categories",
"type": "object"
} | MIT | en |
Exit-9B/CraftingCategories | aee203f08cc1c70f9859595878f094cced276e52 | 2022-12-26T22:36:01 | docs/CraftingCategories.schema.json | 5 | 2024-05-27T07:08:32.505559Z | {
"$defs": {
"category": {
"properties": {
"keywords": {
"description": "Keywords which will assign items to this category if present",
"items": {
"description": "Keyword EditorID",
"type": "string"
},
"type": "array"
},
"section": {
"description": "The parent section which the category is nested under",
"type": "string"
}
},
"required": [
"section"
],
"type": "object"
},
"section": {
"properties": {
"icon": {
"description": "Specifies an icon to appear next to the section label",
"properties": {
"label": {
"description": "Frame label in the timeline to display",
"type": "string"
},
"source": {
"description": "Path to a SWF movie in the Interface directory containing icons",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"keywords": {
"description": "Keywords which will assign items to this section if present",
"items": {
"description": "Keyword EditorID",
"type": "string"
},
"type": "array"
},
"priority": {
"default": 50,
"description": "Global priority (0-100) which controls order relative to other sections",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/Exit-9B/CraftingCategories/main/docs/CraftingCategories.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines categories for the Constructible Object menu",
"properties": {
"categories": {
"description": "Defines sub-categories within sections",
"patternProperties": {
"^[^\\$]": {
"$ref": "#/$defs/category",
"deprecated": true,
"description": "WARNING: String will not be localized"
},
"^\\$": {
"$ref": "#/$defs/category",
"description": "Defines a sub-category within a section"
}
},
"type": "object"
},
"sections": {
"description": "Defines top-level sections",
"patternProperties": {
"^[^\\$]": {
"$ref": "#/$defs/section",
"deprecated": true,
"description": "WARNING: String will not be localized"
},
"^\\$": {
"$ref": "#/$defs/section",
"description": "Defines a top-level section"
}
},
"type": "object"
}
},
"title": "Crafting Categories",
"type": "object"
} | MIT | en |
SapiensAnatis/Dawnshard | d39d067261c0b6e819332522d0eb21ff517c29a9 | 2024-04-15T22:23:02 | DragaliaAPI/DragaliaAPI/Resources/bannerConfig.schema.json | 75 | 2024-05-27T07:12:54.010364Z | {
"$defs": {
"chara": {
"enum": [
"Marty",
"ValentinesOrion",
"Zardin",
"Raemond",
"Rodrigo",
"ThePrince",
"Karl",
"Serena",
"HalloweenOdetta",
"KuHai",
"TemplarHope",
"Odetta",
"Berserker",
"Audric",
"Naveed",
"Marth",
"Lea",
"HunterBerserker",
"Chrom",
"UndercoverGrace",
"Xander",
"SummerCelliera",
"Eugene",
"SummerIeyasu",
"GalaRanzal",
"WeddingElisanne",
"GalaLeif",
"Mona",
"Nino",
"BondforgedPrince",
"Albert",
"Alfonse",
"GalaPrince",
"Pecorine",
"CivilianLeif",
"Yaten",
"GalaAlex",
"Alberius",
"GalaNedrick",
"Aoi",
"Jurota",
"Melody",
"HalloweenEdward",
"Taro",
"Laxi",
"Celliera",
"SummerRanzal",
"Musashi",
"Addis",
"Yachiyo",
"Hanabusa",
"Durant",
"Aldred",
"Mikoto",
"Rena",
"Nobunaga",
"ArmoredYachiyo",
"Valerio",
"HalloweenAkasha",
"GalaMascula",
"Regina",
"Victor",
"Tobias",
"ForagerMitsuba",
"YukataLathna",
"Harle",
"BeauticianZardin",
"GalaLuca",
"Mordecai",
"HumanoidJupiter",
"Ieyasu",
"Natalie",
"Linnea",
"GalaZethia",
"Renelle",
"Francesca",
"Irfan",
"Vice",
"Vida",
"Melsa",
"Yuya",
"Luther",
"Orsem",
"Renee",
"SuFang",
"Fritz",
"Fleur",
"Orion",
"Alex",
"Ezelith",
"GalaLaxi",
"SummerMitsuhide",
"Sheila",
"DragonyuleCleo",
"Mitsuba",
"Tiki",
"HumanoidMercury",
"WeddingAoi",
"SummerNorwin",
"GalaNotte",
"DragonyuleNevin",
"Mitsuhide",
"WuKong",
"YukataCurran",
"Farren",
"Delphi",
"Bellina",
"Nevin",
"Joker",
"SummerPrince",
"Rex",
"Pietro",
"Johanna",
"Linus",
"Erik",
"Vanessa",
"Yue",
"Karina",
"Ranzal",
"SummerLuca",
"Sazanka",
"Ramona",
"HalloweenMym",
"ChildRanzal",
"GalaGatov",
"SummerJulietta",
"GalaElisanne",
"Lazry",
"Finni",
"LinYou",
"ValentinesMelody",
"SummerAmane",
"KimonoLuca",
"Shingen",
"Julietta",
"DragonyuleMalora",
"ZhuBajie",
"SophiePersona",
"GalaAudric",
"Valyx",
"Curran",
"SummerPatia",
"DragonyuleVictor",
"Alain",
"Cibella",
"Jakob",
"Malka",
"Zace",
"XuanZang",
"Emma",
"Elisanne",
"Gauld",
"Aeleen",
"Pia",
"Ryozen",
"ShaWujing",
"Botan",
"Patia",
"GalaMym",
"Nadine",
"KimonoElisanne",
"Panther",
"Xainfried",
"Fjorm",
"Catherine",
"FaeblessedTobias",
"Sylas",
"Kirsty",
"HalloweenMelsa",
"Grimnir",
"Izumo",
"Phares",
"Annelie",
"HalloweenElisanne",
"HunterVanessa",
"Sharena",
"Ryszarda",
"Forte",
"Lathna",
"SummerLeonidas",
"Yukimura",
"Joe",
"Waike",
"Philia",
"Malora",
"ValentinesEzelith",
"DragonyuleNefaria",
"Eleonora",
"Joachim",
"Luca",
"Rawn",
"Elias",
"Norwin",
"GalaSarisse",
"Chelsea",
"SummerAlex",
"Laranoa",
"HunterSarisse",
"Pinon",
"HousekeeperPia",
"Louise",
"Hawk",
"Meene",
"ValentinesChelsea",
"HumanoidMidgardsormr",
"SummerCleo",
"SummerMikoto",
"Isaac",
"Nefaria",
"ValentinesAddis",
"Chelle",
"OperaKarina",
"HalloweenSylas",
"Xania",
"Nicolas",
"XiaoLei",
"Althemia",
"Sinoa",
"DragonyuleXander",
"SummerEstelle",
"Pipple",
"Noelle",
"DragonyuleXainfried",
"Amane",
"Chitose",
"Kleimann",
"StudentMaribelle",
"MegaMan",
"IncognitoNefaria",
"Seimei",
"YukataCleo",
"Lily",
"Yurius",
"ForagerCleo",
"GalaEmile",
"Origa",
"Maribelle",
"SummerSinoa",
"Myriam",
"Basileus",
"Lucretia",
"Peony",
"RadiantXuanZang",
"SummerChelle",
"BondforgedZethia",
"Veronica",
"GalaCleo",
"Cassandra",
"Zena",
"Vania",
"Aurien",
"Ricardt",
"Sophie",
"Hope",
"Estelle",
"Edward",
"Verica",
"HalloweenLowen",
"Thaniel",
"NurseAeleen",
"Lowen",
"WeddingXania",
"HalloweenAlthemia",
"Vixel",
"Felicia",
"Cleo",
"ValentinesHildegarde",
"YukataCassandra",
"Kuzunoha",
"AyahaampOtoha",
"JiangZiya",
"DragonyuleLily",
"Sandalphon",
"Akasha",
"FormalNoelle",
"Nina",
"Hildegarde",
"GalaZena",
"KimonoNotte",
"Heinwald",
"SummerVerica",
"Grace",
"SharpshooterJoe",
"GalaLeonidas",
"Faris",
"DragonyuleIlia",
"Lapis",
"Yoshitsune",
"SharpshooterSarisse",
"FormalJoachim",
"Saiga",
"Cecile",
"Ilia",
"Eirene",
"HalloweenLaxi",
"GalaChelle",
"SummerMym",
"HumanoidZodiark"
]
},
"dragon": {
"enum": [
"Homura",
"CinderDrake",
"KindlingImp",
"Fubuki",
"SnowDrake",
"WellspringImp",
"Tsumuji",
"GustDrake",
"ZephyrImp",
"Hinata",
"MoonDrake",
"AstralImp",
"Hikage",
"GloomDrake",
"PallidImp",
"Brunhilda",
"Phoenix",
"Ifrit",
"Mercury",
"Poliahu",
"Vodyanoy",
"Midgardsormr",
"Roc",
"Stribog",
"Jupiter",
"Unicorn",
"Lindworm",
"HalloweenSilke",
"Zodiark",
"Juggernaut",
"Silke",
"BronzeFafnir",
"SilverFafnir",
"Agni",
"HighBrunhilda",
"Pele",
"Cerberus",
"Erasmus",
"Prometheus",
"KonohanaSakuya",
"Arctos",
"Apollo",
"Kagutsuchi",
"Rathalos",
"DreadkingRathalos",
"GalaMars",
"Horus",
"MiniHildy",
"GozuTenno",
"GalaRebornAgni",
"Uriel",
"PrimalBrunhilda",
"Poseidon",
"HighMercury",
"Leviathan",
"Siren",
"DragonyuleJeanne",
"PengLai",
"Simurgh",
"HalloweenMaritimus",
"Kamuy",
"Nimis",
"GaibhneCreidhne",
"Styx",
"GalaRebornPoseidon",
"Gabriel",
"MiniMercs",
"SummerMarishiten",
"GalaBeastCiella",
"Zephyr",
"HighMidgardsormr",
"Sylvia",
"Garuda",
"LongLong",
"Pazuzu",
"Yulong",
"Freyja",
"Vayu",
"MiniMids",
"Hastur",
"AC011Garland",
"Ariel",
"SummerKonohanaSakuya",
"MidgardsormrZero",
"GalaRebornZephyr",
"Menoetius",
"RoseQueen",
"GalaBeastVolk",
"FudoMyoo",
"Michael",
"JeannedArc",
"HighJupiter",
"CorsaintPhoenix",
"Gilgamesh",
"Cupid",
"Shishimai",
"Liger",
"Takemikazuchi",
"PopStarSiren",
"Daikokuten",
"TieShanGongzhu",
"GalaThor",
"LumierePandora",
"GalaRebornJeanne",
"Raphael",
"SummerCatSith",
"MiniJupi",
"GalaChronosNyx",
"GalaElysium",
"Nidhogg",
"HighZodiark",
"Phantom",
"Maritimus",
"Marishiten",
"GoldFafnir",
"Nyarlathotep",
"Shinobi",
"Chthonius",
"ParallelZodiark",
"Ebisu",
"Fatalis",
"Epimetheus",
"MiniZodi",
"Andromeda",
"Barbatos",
"Azazel",
"GalaCatSith",
"Ramiel",
"Giovanni",
"Arsene",
"HighChthonius",
"GalaRebornNidhogg",
"GalaBahamut",
"Puppy"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Configuration for Dawnshard's banner system",
"properties": {
"SummonBannerOptions": {
"properties": {
"Banners": {
"items": {
"properties": {
"Id": {
"type": "integer"
},
"IsGala": {
"type": "boolean"
},
"IsPrizeShowcase": {
"type": "boolean"
},
"LimitedCharas": {
"items": {
"$ref": "#/$defs/chara"
},
"type": "array"
},
"LimitedDragons": {
"items": {
"$ref": "#/$defs/dragon"
},
"type": "array"
},
"PickupCharas": {
"items": {
"$ref": "#/$defs/chara"
},
"type": "array"
},
"PickupDragons": {
"items": {
"$ref": "#/$defs/dragon"
},
"type": "array"
},
"Start": {
"format": "date-time",
"type": "string"
},
"TradeCharas": {
"items": {
"$ref": "#/$defs/chara"
},
"type": "array"
},
"TradeDragons": {
"items": {
"$ref": "#/$defs/dragon"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"title": "Banner Configuration",
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | f92c4dc5f59af2ef90f37356a62e93e65f58722a | 2020-07-04T22:33:06 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"additionalProperties": false,
"definitions": {
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"description": "The raw signature returned from the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"description": "Contains the Relying Party's ID for the user",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/definitions/PlatformAttachment"
},
{
"$ref": "#/definitions/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"properties": {
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"type": "string"
},
"rawId": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions"
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"properties": {
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"type": "string"
},
"rawId": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"properties": {
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"properties": {
"alg": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"properties": {
"attestation": {
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"items": {
"$ref": "#/definitions/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity"
},
"timeout": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity"
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "FOOBAR",
"properties": {
"allowCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"userVerification": {
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"RelyingPartyEntity": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"properties": {
"allowed_credentials": {
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"type": "string"
},
"userVerification": {
"type": "string"
},
"user_id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"credentials": {
"items": {
"$ref": "#/definitions/Credential"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"iconURL": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/definitions/SessionData"
},
"User": {
"$ref": "#/definitions/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 25aeb05c68c269589d553fd607aaf13866358f66 | 2022-09-18T17:20:12 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"AuthenticationExtensions": {
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"type": "string"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Challenge": {
"contentEncoding": "base64",
"type": "string"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"contentEncoding": "base64",
"description": "The ID of a credential to allow/disallow.",
"type": "string"
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/Challenge",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/Challenge",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions"
},
"userVerification": {
"default": "preferred",
"description": "Required user verification in this login or registration ceremony.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "User's icon url.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "A URL which resolves to an image associated with the user account.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "The user handle of the user account.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 6c6e3aa4b221b5c81a868d4cb64fad1ee7474ba4 | 2024-01-01T11:20:02 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"const": -7,
"description": "ECDSA with SHA-256"
},
"AlgES256K": {
"const": -47,
"description": "ECDSA using secp256k1 curve and SHA-256."
},
"AlgES384": {
"const": -35,
"description": "ECDSA with SHA-384"
},
"AlgES512": {
"const": -36,
"description": "ECDSA with SHA-512"
},
"AlgEdDSA": {
"const": -8,
"description": "EdDSA"
},
"AlgPS256": {
"const": -37,
"description": "RSASSA-PSS with SHA-256"
},
"AlgPS384": {
"const": -38,
"description": "RSASSA-PSS with SHA-384"
},
"AlgPS512": {
"const": -39,
"description": "RSASSA-PSS with SHA-512"
},
"AlgRS1": {
"const": -65535,
"description": "RSASSA-PKCS1-v1_5 with SHA-1"
},
"AlgRS256": {
"const": -257,
"description": "RSASSA-PKCS1-v1_5 with SHA-256"
},
"AlgRS384": {
"const": -258,
"description": "RSASSA-PKCS1-v1_5 with SHA-384"
},
"AlgRS512": {
"const": -259,
"description": "RSASSA-PKCS1-v1_5 with SHA-512"
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"description": "Contains the results of processing client extensions requested by the Relying Party.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "The {@link AuthenticatorSelection.authenticatorAttachment} value returned by the request.",
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
]
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"description": "These values are the transports that the authenticator is believed to support, or an empty sequence if the information is unavailable.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"requireResidentKey": {
"default": false,
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"description": "Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated \u201cresident\u201d terminology.",
"type": "string"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"type": "object"
},
"AuthenticatorTransport": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
]
},
"COSEAlgorithmIdentifier": {
"anyOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
},
{
"$ref": "#/$defs/AlgES256K"
}
]
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"$ref": "#/$defs/ConveyancePreference",
"description": "Preferred attestation conveyance during credential generation",
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "Enables various debug options.",
"type": "boolean"
},
"EncodeUserIDAsString": {
"description": "Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "@deprecated This option has been removed from newer specifications due to security considerations.",
"type": "string"
},
"RPOrigin": {
"description": "@deprecated Use RPOrigins instead.",
"type": "string"
},
"RPOrigins": {
"description": "Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.",
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "@deprecated Use Timeouts instead.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig",
"description": "Configures various timeouts."
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins"
],
"type": "object"
},
"ConveyancePreference": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
},
{
"$ref": "#/$defs/PreferEnterpriseAttestation"
}
],
"default": {
"$ref": "#/$defs/PreferNoAttestation"
}
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags",
"description": "The commonly stored flags."
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"description": "The transport types the authenticator supports.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"description": "@deprecated Deprecated due to upstream changes to the API. Use {@link AuthenticatorAttestationResponse.transports} instead.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "The authenticator transports that can be used.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"description": "Flags associated with a credential",
"properties": {
"BackupEligible": {
"description": "Indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change.",
"type": "boolean"
},
"BackupState": {
"description": "Indicates the credential has been backed up and/or sync'd. This value can change but it's recommended that RP's keep track of this value.",
"type": "boolean"
},
"UserPresent": {
"description": "Indicates the users presence.",
"type": "boolean"
},
"UserVerified": {
"description": "Indicates the user performed verification.",
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"$ref": "#/$defs/COSEAlgorithmIdentifier",
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"type": "integer"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CredentialType": {
"$ref": "#/$defs/PublicKeyCredentialType"
},
"CrossPlatformAttachment": {
"const": "cross-platform",
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential."
},
"PlatformAttachment": {
"const": "platform",
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential."
},
"PreferDirectAttestation": {
"const": "direct",
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator."
},
"PreferEnterpriseAttestation": {
"const": "enterprise",
"description": "Indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID. If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party."
},
"PreferIndirectAttestation": {
"const": "indirect",
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem."
},
"PreferNoAttestation": {
"const": "none",
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified."
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"$ref": "#/$defs/ConveyancePreference",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"const": "public-key",
"description": "Credential type for WebAuthn."
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"description": "When this data expires",
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Contains additional parameters requesting additional processing by the client and authenticator."
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Required user verification in this login or registration ceremony.",
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration for either registration or login.",
"properties": {
"Enforce": {
"description": "Enforce the timeouts at the Relying Party / Server. This means if enabled and the user takes too long that even if the browser does not enforce the timeout the Relying Party / Server will.",
"type": "boolean"
},
"Timeout": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to anything other than discouraged.",
"type": "integer"
},
"TimeoutUVD": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to discouraged.",
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration.",
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for login."
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for registration."
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"TransportBLE": {
"const": "ble",
"description": "Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE)."
},
"TransportHybrid": {
"const": "hybrid",
"description": "Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone."
},
"TransportInternal": {
"const": "internal",
"description": "Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device."
},
"TransportNFC": {
"const": "nfc",
"description": "Indicates the respective authenticator can be contacted over Near Field Communication (NFC)."
},
"TransportUSB": {
"const": "usb",
"description": "Indicates the respective authenticator can be contacted over removable USB"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"description": "URL-encoded base64 data.",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "@deprecated This has been removed from the specification recommendation. Suggest a blank string.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "@deprecated This has been removed from the specification recommendations.",
"type": "string"
},
"id": {
"description": "The user handle of the user account. *//* eslint-disable-next-line @typescript-eslint/no-explicit-any"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"const": "discouraged",
"description": "The authenticator should not verify the user for the credential."
},
"UserVerificationPreferred": {
"const": "preferred",
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified."
},
"UserVerificationRequired": {
"const": "required",
"description": "User verification is required to create/use a credential."
},
"UserVerificationRequirement": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": {
"$ref": "#/$defs/UserVerificationPreferred"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 92cc236a492369258c14648d391063fd9fd82eb2 | 2023-12-31T22:54:23 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"const": -7,
"description": "ECDSA with SHA-256"
},
"AlgES256K": {
"const": -47,
"description": "ECDSA using secp256k1 curve and SHA-256."
},
"AlgES384": {
"const": -35,
"description": "ECDSA with SHA-384"
},
"AlgES512": {
"const": -36,
"description": "ECDSA with SHA-512"
},
"AlgEdDSA": {
"const": -8,
"description": "EdDSA"
},
"AlgPS256": {
"const": -37,
"description": "RSASSA-PSS with SHA-256"
},
"AlgPS384": {
"const": -38,
"description": "RSASSA-PSS with SHA-384"
},
"AlgPS512": {
"const": -39,
"description": "RSASSA-PSS with SHA-512"
},
"AlgRS1": {
"const": -65535,
"description": "RSASSA-PKCS1-v1_5 with SHA-1"
},
"AlgRS256": {
"const": -257,
"description": "RSASSA-PKCS1-v1_5 with SHA-256"
},
"AlgRS384": {
"const": -258,
"description": "RSASSA-PKCS1-v1_5 with SHA-384"
},
"AlgRS512": {
"const": -259,
"description": "RSASSA-PKCS1-v1_5 with SHA-512"
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"description": "Contains the results of processing client extensions requested by the Relying Party.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "The {@link AuthenticatorSelection.authenticatorAttachment} value returned by the request.",
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
]
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"description": "These values are the transports that the authenticator is believed to support, or an empty sequence if the information is unavailable.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"requireResidentKey": {
"default": false,
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"description": "Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated \u201cresident\u201d terminology.",
"type": "string"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"type": "object"
},
"AuthenticatorTransport": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
]
},
"COSEAlgorithmIdentifier": {
"anyOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
},
{
"$ref": "#/$defs/AlgES256K"
}
]
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"$ref": "#/$defs/ConveyancePreference",
"description": "Preferred attestation conveyance during credential generation",
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "Enables various debug options.",
"type": "boolean"
},
"EncodeUserIDAsString": {
"description": "Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "@deprecated This option has been removed from newer specifications due to security considerations.",
"type": "string"
},
"RPOrigin": {
"description": "@deprecated Use RPOrigins instead.",
"type": "string"
},
"RPOrigins": {
"description": "Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.",
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "@deprecated Use Timeouts instead.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig",
"description": "Configures various timeouts."
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins",
"AttestationPreference",
"AuthenticatorSelection",
"Debug",
"EncodeUserIDAsString",
"Timeouts",
"RPIcon",
"RPOrigin",
"Timeout"
],
"type": "object"
},
"ConveyancePreference": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
},
{
"$ref": "#/$defs/PreferEnterpriseAttestation"
}
],
"default": {
"$ref": "#/$defs/PreferNoAttestation"
}
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags",
"description": "The commonly stored flags."
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"description": "The transport types the authenticator supports.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"description": "@deprecated Deprecated due to upstream changes to the API. Use {@link AuthenticatorAttestationResponse.transports} instead.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "The authenticator transports that can be used.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"description": "Flags associated with a credential",
"properties": {
"BackupEligible": {
"description": "Indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change.",
"type": "boolean"
},
"BackupState": {
"description": "Indicates the credential has been backed up and/or sync'd. This value can change but it's recommended that RP's keep track of this value.",
"type": "boolean"
},
"UserPresent": {
"description": "Indicates the users presence.",
"type": "boolean"
},
"UserVerified": {
"description": "Indicates the user performed verification.",
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"$ref": "#/$defs/COSEAlgorithmIdentifier",
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"type": "integer"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CredentialType": {
"$ref": "#/$defs/PublicKeyCredentialType"
},
"CrossPlatformAttachment": {
"const": "cross-platform",
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential."
},
"PlatformAttachment": {
"const": "platform",
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential."
},
"PreferDirectAttestation": {
"const": "direct",
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator."
},
"PreferEnterpriseAttestation": {
"const": "enterprise",
"description": "Indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID. If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party."
},
"PreferIndirectAttestation": {
"const": "indirect",
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem."
},
"PreferNoAttestation": {
"const": "none",
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified."
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"$ref": "#/$defs/ConveyancePreference",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"const": "public-key",
"description": "Credential type for WebAuthn."
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"description": "When this data expires",
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Contains additional parameters requesting additional processing by the client and authenticator."
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Required user verification in this login or registration ceremony.",
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration for either registration or login.",
"properties": {
"Enforce": {
"description": "Enforce the timeouts at the Relying Party / Server. This means if enabled and the user takes too long that even if the browser does not enforce the timeout the Relying Party / Server will.",
"type": "boolean"
},
"Timeout": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to anything other than discouraged.",
"type": "integer"
},
"TimeoutUVD": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to discouraged.",
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration.",
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for login."
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for registration."
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"TransportBLE": {
"const": "ble",
"description": "Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE)."
},
"TransportHybrid": {
"const": "hybrid",
"description": "Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone."
},
"TransportInternal": {
"const": "internal",
"description": "Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device."
},
"TransportNFC": {
"const": "nfc",
"description": "Indicates the respective authenticator can be contacted over Near Field Communication (NFC)."
},
"TransportUSB": {
"const": "usb",
"description": "Indicates the respective authenticator can be contacted over removable USB"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"description": "URL-encoded base64 data.",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "@deprecated This has been removed from the specification recommendation. Suggest a blank string.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "@deprecated This has been removed from the specification recommendations.",
"type": "string"
},
"id": {
"description": "The user handle of the user account. *//* eslint-disable-next-line @typescript-eslint/no-explicit-any"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"const": "discouraged",
"description": "The authenticator should not verify the user for the credential."
},
"UserVerificationPreferred": {
"const": "preferred",
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified."
},
"UserVerificationRequired": {
"const": "required",
"description": "User verification is required to create/use a credential."
},
"UserVerificationRequirement": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": {
"$ref": "#/$defs/UserVerificationPreferred"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 3a2cd2d32f0dc690a3fc5bc38f6cd8e62a1ddea8 | 2020-07-06T22:53:10 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"additionalProperties": false,
"definitions": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"description": "The raw signature returned from the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"description": "Contains the Relying Party's ID for the user",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/definitions/PlatformAttachment"
},
{
"$ref": "#/definitions/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"description": "The ID of a credential to allow/disallow.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/definitions/AlgES256"
},
{
"$ref": "#/definitions/AlgES384"
},
{
"$ref": "#/definitions/AlgES512"
},
{
"$ref": "#/definitions/AlgRS1"
},
{
"$ref": "#/definitions/AlgRS256"
},
{
"$ref": "#/definitions/AlgRS384"
},
{
"$ref": "#/definitions/AlgRS512"
},
{
"$ref": "#/definitions/AlgPS256"
},
{
"$ref": "#/definitions/AlgPS384"
},
{
"$ref": "#/definitions/AlgPS512"
},
{
"$ref": "#/definitions/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/definitions/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"userVerification": {
"default": "preferred",
"description": "Required user verification in this login or registration ceremony.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
},
"user_id": {
"description": "ID of the user being registered or logged in.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/definitions/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "User's icon url.",
"type": "string"
},
"id": {
"description": "User ID according to the Relying Party.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "A URL which resolves to an image associated with the user account.",
"type": "string"
},
"id": {
"description": "The user handle of the user account.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/definitions/SessionData"
},
"User": {
"$ref": "#/definitions/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 14c1245199c31e094fa94ce799f146bea267b803 | 2020-06-30T20:30:20 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"additionalProperties": false,
"definitions": {
"Authenticator": {
"additionalProperties": false,
"description": "Class representing the user's authenticator device.",
"properties": {
"AAGUID": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"type": "boolean"
},
"SignCount": {
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"properties": {
"authenticatorData": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"properties": {
"attestationObject": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"properties": {
"authenticatorAttachment": {
"type": "string"
},
"requireResidentKey": {
"type": "boolean"
},
"userVerification": {
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"properties": {
"AttestationPreference": {
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection"
},
"Debug": {
"type": "boolean"
},
"RPDisplayName": {
"type": "string"
},
"RPID": {
"type": "string"
},
"RPIcon": {
"type": "string"
},
"RPOrigin": {
"type": "string"
},
"Timeout": {
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"properties": {
"AttestationType": {
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator"
},
"ID": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions"
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"properties": {
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"type": "string"
},
"rawId": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions"
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"properties": {
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"type": "string"
},
"rawId": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"properties": {
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"properties": {
"alg": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"properties": {
"attestation": {
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection"
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"items": {
"$ref": "#/definitions/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity"
},
"timeout": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity"
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"userVerification": {
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"RelyingPartyEntity": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"properties": {
"allowed_credentials": {
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"type": "string"
},
"userVerification": {
"type": "string"
},
"user_id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"credentials": {
"items": {
"$ref": "#/definitions/Credential"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"iconURL": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/definitions/SessionData"
},
"User": {
"$ref": "#/definitions/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 7b6e0b9bc05a57ceb19c522141ab44cf3b2e286f | 2024-01-15T22:19:58 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"const": -7,
"description": "ECDSA with SHA-256"
},
"AlgES256K": {
"const": -47,
"description": "ECDSA using secp256k1 curve and SHA-256."
},
"AlgES384": {
"const": -35,
"description": "ECDSA with SHA-384"
},
"AlgES512": {
"const": -36,
"description": "ECDSA with SHA-512"
},
"AlgEdDSA": {
"const": -8,
"description": "EdDSA"
},
"AlgPS256": {
"const": -37,
"description": "RSASSA-PSS with SHA-256"
},
"AlgPS384": {
"const": -38,
"description": "RSASSA-PSS with SHA-384"
},
"AlgPS512": {
"const": -39,
"description": "RSASSA-PSS with SHA-512"
},
"AlgRS1": {
"const": -65535,
"description": "RSASSA-PKCS1-v1_5 with SHA-1"
},
"AlgRS256": {
"const": -257,
"description": "RSASSA-PKCS1-v1_5 with SHA-256"
},
"AlgRS384": {
"const": -258,
"description": "RSASSA-PKCS1-v1_5 with SHA-384"
},
"AlgRS512": {
"const": -259,
"description": "RSASSA-PKCS1-v1_5 with SHA-512"
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"description": "Contains the results of processing client extensions requested by the Relying Party.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"attachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "The {@link AuthenticatorSelection.authenticatorAttachment} value returned by the request.",
"type": "string"
},
"cloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"signCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"signCount",
"cloneWarning",
"attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
]
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"description": "These values are the transports that the authenticator is believed to support, or an empty sequence if the information is unavailable.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"requireResidentKey": {
"default": false,
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"description": "Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated \u201cresident\u201d terminology.",
"type": "string"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"type": "object"
},
"AuthenticatorTransport": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
]
},
"COSEAlgorithmIdentifier": {
"anyOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
},
{
"$ref": "#/$defs/AlgES256K"
}
]
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"$ref": "#/$defs/ConveyancePreference",
"description": "Preferred attestation conveyance during credential generation",
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "Enables various debug options.",
"type": "boolean"
},
"EncodeUserIDAsString": {
"description": "Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "@deprecated This option has been removed from newer specifications due to security considerations.",
"type": "string"
},
"RPOrigin": {
"description": "@deprecated Use RPOrigins instead.",
"type": "string"
},
"RPOrigins": {
"description": "Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.",
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "@deprecated Use Timeouts instead.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig",
"description": "Configures various timeouts."
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins"
],
"type": "object"
},
"ConveyancePreference": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
},
{
"$ref": "#/$defs/PreferEnterpriseAttestation"
}
],
"default": {
"$ref": "#/$defs/PreferNoAttestation"
}
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"attestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"flags": {
"$ref": "#/$defs/CredentialFlags",
"description": "The commonly stored flags."
},
"id": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"publicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"transport": {
"description": "The transport types the authenticator supports.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"publicKey",
"attestationType",
"transport",
"flags",
"authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"description": "@deprecated Deprecated due to upstream changes to the API. Use {@link AuthenticatorAttestationResponse.transports} instead.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "The authenticator transports that can be used.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"description": "Flags associated with a credential",
"properties": {
"backupEligible": {
"description": "Indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change.",
"type": "boolean"
},
"backupState": {
"description": "Indicates the credential has been backed up and/or sync'd. This value can change but it's recommended that RP's keep track of this value.",
"type": "boolean"
},
"userPresent": {
"description": "Indicates the users presence.",
"type": "boolean"
},
"userVerified": {
"description": "Indicates the user performed verification.",
"type": "boolean"
}
},
"required": [
"userPresent",
"userVerified",
"backupEligible",
"backupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"$ref": "#/$defs/COSEAlgorithmIdentifier",
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"type": "integer"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CredentialType": {
"$ref": "#/$defs/PublicKeyCredentialType"
},
"CrossPlatformAttachment": {
"const": "cross-platform",
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential."
},
"PlatformAttachment": {
"const": "platform",
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential."
},
"PreferDirectAttestation": {
"const": "direct",
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator."
},
"PreferEnterpriseAttestation": {
"const": "enterprise",
"description": "Indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID. If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party."
},
"PreferIndirectAttestation": {
"const": "indirect",
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem."
},
"PreferNoAttestation": {
"const": "none",
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified."
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"$ref": "#/$defs/ConveyancePreference",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"const": "public-key",
"description": "Credential type for WebAuthn."
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"description": "When this data expires",
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Contains additional parameters requesting additional processing by the client and authenticator."
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Required user verification in this login or registration ceremony.",
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration for either registration or login.",
"properties": {
"Enforce": {
"description": "Enforce the timeouts at the Relying Party / Server. This means if enabled and the user takes too long that even if the browser does not enforce the timeout the Relying Party / Server will.",
"type": "boolean"
},
"Timeout": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to anything other than discouraged.",
"type": "integer"
},
"TimeoutUVD": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to discouraged.",
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration.",
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for login."
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for registration."
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"TransportBLE": {
"const": "ble",
"description": "Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE)."
},
"TransportHybrid": {
"const": "hybrid",
"description": "Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone."
},
"TransportInternal": {
"const": "internal",
"description": "Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device."
},
"TransportNFC": {
"const": "nfc",
"description": "Indicates the respective authenticator can be contacted over Near Field Communication (NFC)."
},
"TransportUSB": {
"const": "usb",
"description": "Indicates the respective authenticator can be contacted over removable USB"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"description": "URL-encoded base64 data.",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "@deprecated This has been removed from the specification recommendation. Suggest a blank string.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "@deprecated This has been removed from the specification recommendations.",
"type": "string"
},
"id": {
"description": "The user handle of the user account. *//* eslint-disable-next-line @typescript-eslint/no-explicit-any"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"displayName",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"const": "discouraged",
"description": "The authenticator should not verify the user for the credential."
},
"UserVerificationPreferred": {
"const": "preferred",
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified."
},
"UserVerificationRequired": {
"const": "required",
"description": "User verification is required to create/use a credential."
},
"UserVerificationRequirement": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": {
"$ref": "#/$defs/UserVerificationPreferred"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 37c31450008bbc9d4a95ee2d737a487feb243673 | 2023-12-20T22:05:06 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"const": -7,
"description": "ECDSA with SHA-256"
},
"AlgES256K": {
"const": -47,
"description": "ECDSA using secp256k1 curve and SHA-256."
},
"AlgES384": {
"const": -35,
"description": "ECDSA with SHA-384"
},
"AlgES512": {
"const": -36,
"description": "ECDSA with SHA-512"
},
"AlgEdDSA": {
"const": -8,
"description": "EdDSA"
},
"AlgPS256": {
"const": -37,
"description": "RSASSA-PSS with SHA-256"
},
"AlgPS384": {
"const": -38,
"description": "RSASSA-PSS with SHA-384"
},
"AlgPS512": {
"const": -39,
"description": "RSASSA-PSS with SHA-512"
},
"AlgRS1": {
"const": -65535,
"description": "RSASSA-PKCS1-v1_5 with SHA-1"
},
"AlgRS256": {
"const": -257,
"description": "RSASSA-PKCS1-v1_5 with SHA-256"
},
"AlgRS384": {
"const": -258,
"description": "RSASSA-PKCS1-v1_5 with SHA-384"
},
"AlgRS512": {
"const": -259,
"description": "RSASSA-PKCS1-v1_5 with SHA-512"
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"description": "Contains the results of processing client extensions requested by the Relying Party.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "The {@link AuthenticatorSelection.authenticatorAttachment} value returned by the request.",
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
]
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"description": "These values are the transports that the authenticator is believed to support, or an empty sequence if the information is unavailable.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"requireResidentKey": {
"default": false,
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"description": "Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated \u201cresident\u201d terminology.",
"type": "string"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"type": "object"
},
"AuthenticatorTransport": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
]
},
"COSEAlgorithmIdentifier": {
"anyOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
},
{
"$ref": "#/$defs/AlgES256K"
}
]
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"$ref": "#/$defs/ConveyancePreference",
"description": "Preferred attestation conveyance during credential generation",
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "Enables various debug options.",
"type": "boolean"
},
"EncodeUserIDAsString": {
"description": "Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "@deprecated This option has been removed from newer specifications due to security considerations.",
"type": "string"
},
"RPOrigin": {
"description": "@deprecated Use RPOrigins instead.",
"type": "string"
},
"RPOrigins": {
"description": "Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.",
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "@deprecated Use Timeouts instead.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig",
"description": "Configures various timeouts."
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins",
"AttestationPreference",
"AuthenticatorSelection",
"Debug",
"EncodeUserIDAsString",
"Timeouts",
"RPIcon",
"RPOrigin",
"Timeout"
],
"type": "object"
},
"ConveyancePreference": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
},
{
"$ref": "#/$defs/PreferEnterpriseAttestation"
}
],
"default": "#/$defs/PreferNoAttestation"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags",
"description": "The commonly stored flags."
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"description": "The transport types the authenticator supports.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"$ref": "#/$defs/AuthenticatorAttachment",
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"description": "@deprecated Deprecated due to upstream changes to the API. Use {@link AuthenticatorAttestationResponse.transports} instead.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/PublicKeyCredentialType",
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "The authenticator transports that can be used.",
"items": {
"$ref": "#/$defs/AuthenticatorTransport",
"type": "string"
},
"type": "array"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"description": "Flags associated with a credential",
"properties": {
"BackupEligible": {
"description": "Indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change.",
"type": "boolean"
},
"BackupState": {
"description": "Indicates the credential has been backed up and/or sync'd. This value can change but it's recommended that RP's keep track of this value.",
"type": "boolean"
},
"UserPresent": {
"description": "Indicates the users presence.",
"type": "boolean"
},
"UserVerified": {
"description": "Indicates the user performed verification.",
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"$ref": "#/$defs/COSEAlgorithmIdentifier",
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"type": "integer"
},
"type": {
"$ref": "#/$defs/CredentialType",
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CredentialType": {
"$ref": "#/$defs/PublicKeyCredentialType"
},
"CrossPlatformAttachment": {
"const": "cross-platform",
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential."
},
"PlatformAttachment": {
"const": "platform",
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential."
},
"PreferDirectAttestation": {
"const": "direct",
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator."
},
"PreferEnterpriseAttestation": {
"const": "enterprise",
"description": "Indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID. If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party."
},
"PreferIndirectAttestation": {
"const": "indirect",
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem."
},
"PreferNoAttestation": {
"const": "none",
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified."
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"$ref": "#/$defs/ConveyancePreference",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"const": "public-key",
"description": "Credential type for WebAuthn."
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"description": "When this data expires",
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Contains additional parameters requesting additional processing by the client and authenticator."
},
"userVerification": {
"$ref": "#/$defs/UserVerificationRequirement",
"description": "Required user verification in this login or registration ceremony.",
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration for either registration or login.",
"properties": {
"Enforce": {
"description": "Enforce the timeouts at the Relying Party / Server. This means if enabled and the user takes too long that even if the browser does not enforce the timeout the Relying Party / Server will.",
"type": "boolean"
},
"Timeout": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to anything other than discouraged.",
"type": "integer"
},
"TimeoutUVD": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to discouraged.",
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration.",
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for login."
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for registration."
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"TransportBLE": {
"const": "ble",
"description": "Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE)."
},
"TransportHybrid": {
"const": "hybrid",
"description": "Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone."
},
"TransportInternal": {
"const": "internal",
"description": "Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device."
},
"TransportNFC": {
"const": "nfc",
"description": "Indicates the respective authenticator can be contacted over Near Field Communication (NFC)."
},
"TransportUSB": {
"const": "usb",
"description": "Indicates the respective authenticator can be contacted over removable USB"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"description": "URL-encoded base64 data.",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "@deprecated This has been removed from the specification recommendation. Suggest a blank string.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "@deprecated This has been removed from the specification recommendations.",
"type": "string"
},
"id": {
"description": "The user handle of the user account. *//* eslint-disable-next-line @typescript-eslint/no-explicit-any"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"const": "discouraged",
"description": "The authenticator should not verify the user for the credential."
},
"UserVerificationPreferred": {
"const": "preferred",
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified."
},
"UserVerificationRequired": {
"const": "required",
"description": "User verification is required to create/use a credential."
},
"UserVerificationRequirement": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": "#/$defs/UserVerificationPreferred"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 0bcdd8b3d226768079e297a29227f6cb5f1674e2 | 2021-06-27T08:01:02 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"description": "The raw signature returned from the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"description": "Contains the Relying Party's ID for the user",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/definitions/PlatformAttachment"
},
{
"$ref": "#/definitions/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"description": "The ID of a credential to allow/disallow.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/definitions/AlgES256"
},
{
"$ref": "#/definitions/AlgES384"
},
{
"$ref": "#/definitions/AlgES512"
},
{
"$ref": "#/definitions/AlgRS1"
},
{
"$ref": "#/definitions/AlgRS256"
},
{
"$ref": "#/definitions/AlgRS384"
},
{
"$ref": "#/definitions/AlgRS512"
},
{
"$ref": "#/definitions/AlgPS256"
},
{
"$ref": "#/definitions/AlgPS384"
},
{
"$ref": "#/definitions/AlgPS512"
},
{
"$ref": "#/definitions/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/definitions/CredentialDescriptor",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/definitions/CredentialParameter",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"userVerification": {
"default": "preferred",
"description": "Required user verification in this login or registration ceremony.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
},
"user_id": {
"description": "ID of the user being registered or logged in.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/definitions/Credential",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "User's icon url.",
"type": "string"
},
"id": {
"description": "User ID according to the Relying Party.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "A URL which resolves to an image associated with the user account.",
"type": "string"
},
"id": {
"description": "The user handle of the user account.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"SessionData": {
"$ref": "#/definitions/SessionData",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"User": {
"$ref": "#/definitions/User",
"$schema": "http://json-schema.org/draft-04/schema#"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | a4e6944984806f2b5c0e36c680ff850042c5190c | 2023-12-11T21:18:55 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"AuthenticationExtensions": {
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"type": "string"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"EncodeUserIDAsString": {
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"RPOrigins": {
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig"
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins",
"AttestationPreference",
"AuthenticatorSelection",
"Debug",
"EncodeUserIDAsString",
"Timeouts",
"RPIcon",
"RPOrigin",
"Timeout"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags"
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"properties": {
"BackupEligible": {
"type": "boolean"
},
"BackupState": {
"type": "boolean"
},
"UserPresent": {
"type": "boolean"
},
"UserVerified": {
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions"
},
"userVerification": {
"default": "preferred",
"description": "Required user verification in this login or registration ceremony.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"properties": {
"Enforce": {
"type": "boolean"
},
"Timeout": {
"type": "integer"
},
"TimeoutUVD": {
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig"
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig"
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "User's icon url.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "A URL which resolves to an image associated with the user account.",
"type": "string"
},
"id": {
"description": "The user handle of the user account."
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 0125c602b2394e3d046a9894409fc1dc5ad2d7f9 | 2020-07-06T22:09:52 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"additionalProperties": false,
"definitions": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"description": "The raw signature returned from the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"description": "Contains the Relying Party's ID for the user",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/definitions/PlatformAttachment"
},
{
"$ref": "#/definitions/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"description": "The ID of a credential to allow/disallow.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/definitions/AlgES256"
},
{
"$ref": "#/definitions/AlgES384"
},
{
"$ref": "#/definitions/AlgES512"
},
{
"$ref": "#/definitions/AlgRS1"
},
{
"$ref": "#/definitions/AlgRS256"
},
{
"$ref": "#/definitions/AlgRS384"
},
{
"$ref": "#/definitions/AlgRS512"
},
{
"$ref": "#/definitions/AlgPS256"
},
{
"$ref": "#/definitions/AlgPS384"
},
{
"$ref": "#/definitions/AlgPS512"
},
{
"$ref": "#/definitions/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/definitions/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"properties": {
"allowed_credentials": {
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"type": "string"
},
"userVerification": {
"type": "string"
},
"user_id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"credentials": {
"items": {
"$ref": "#/definitions/Credential"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"iconURL": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/definitions/SessionData"
},
"User": {
"$ref": "#/definitions/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | bf65d0eb5aec58ee85ba7179397ff3dcbf640e4f | 2023-12-17T21:59:27 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"const": -7,
"description": "ECDSA with SHA-256"
},
"AlgES256K": {
"const": -47,
"description": "ECDSA using secp256k1 curve and SHA-256."
},
"AlgES384": {
"const": -35,
"description": "ECDSA with SHA-384"
},
"AlgES512": {
"const": -36,
"description": "ECDSA with SHA-512"
},
"AlgEdDSA": {
"const": -8,
"description": "EdDSA"
},
"AlgPS256": {
"const": -37,
"description": "RSASSA-PSS with SHA-256"
},
"AlgPS384": {
"const": -38,
"description": "RSASSA-PSS with SHA-384"
},
"AlgPS512": {
"const": -39,
"description": "RSASSA-PSS with SHA-512"
},
"AlgRS1": {
"const": -65535,
"description": "RSASSA-PKCS1-v1_5 with SHA-1"
},
"AlgRS256": {
"const": -257,
"description": "RSASSA-PKCS1-v1_5 with SHA-256"
},
"AlgRS384": {
"const": -258,
"description": "RSASSA-PKCS1-v1_5 with SHA-384"
},
"AlgRS512": {
"const": -259,
"description": "RSASSA-PKCS1-v1_5 with SHA-512"
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"description": "Contains the results of processing client extensions requested by the Relying Party.eslint-disable-next-line @typescript-eslint/no-explicit-any",
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"description": "The {@link AuthenticatorSelection.authenticatorAttachment} value returned by the request.",
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"description": "These values are the transports that the authenticator is believed to support, or an empty sequence if the information is unavailable.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"description": "Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated \u201cresident\u201d terminology.",
"type": "string"
},
"userVerification": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": "#/$defs/UserVerificationPreferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
},
{
"$ref": "#/$defs/PreferEnterpriseAttestation"
}
],
"default": "#/$defs/PreferNoAttestation",
"description": "Preferred attestation conveyance during credential generation",
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "Enables various debug options.",
"type": "boolean"
},
"EncodeUserIDAsString": {
"description": "Ensures the user.id value during registrations is encoded as a raw UTF8 string. This is useful when you only use printable ASCII characters for the random user.id but the browser library does not decode the URL Safe Base64 data.",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "@deprecated This option has been removed from newer specifications due to security considerations.",
"type": "string"
},
"RPOrigin": {
"description": "@deprecated Use RPOrigins instead.",
"type": "string"
},
"RPOrigins": {
"description": "Configures the list of Relying Party Server Origins that are permitted. These should be fully qualified origins.",
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "@deprecated Use Timeouts instead.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig",
"description": "Configures various timeouts."
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins",
"AttestationPreference",
"AuthenticatorSelection",
"Debug",
"EncodeUserIDAsString",
"Timeouts",
"RPIcon",
"RPOrigin",
"Timeout"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags",
"description": "The commonly stored flags."
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"description": "The transport types the authenticator supports.",
"items": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
],
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"anyOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs",
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"description": "@deprecated Deprecated due to upstream changes to the API. Use {@link AuthenticatorAttestationResponse.transports} instead.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"description": "Specifies the credential type represented by this object.",
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "The authenticator transports that can be used.",
"items": {
"anyOf": [
{
"$ref": "#/$defs/TransportUSB"
},
{
"$ref": "#/$defs/TransportNFC"
},
{
"$ref": "#/$defs/TransportBLE"
},
{
"$ref": "#/$defs/TransportHybrid"
},
{
"$ref": "#/$defs/TransportInternal"
}
],
"type": "string"
},
"type": "array"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"description": "Flags associated with a credential",
"properties": {
"BackupEligible": {
"description": "Indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change.",
"type": "boolean"
},
"BackupState": {
"description": "Indicates the credential has been backed up and/or sync'd. This value can change but it's recommended that RP's keep track of this value.",
"type": "boolean"
},
"UserPresent": {
"description": "Indicates the users presence.",
"type": "boolean"
},
"UserVerified": {
"description": "Indicates the user performed verification.",
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"anyOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
}
],
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"type": "integer"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"description": "Type of the credential to use.",
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"const": "cross-platform",
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential."
},
"PlatformAttachment": {
"const": "platform",
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential."
},
"PreferDirectAttestation": {
"const": "direct",
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator."
},
"PreferEnterpriseAttestation": {
"const": "enterprise",
"description": "Indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information. This is intended for controlled deployments within an enterprise where the organization wishes to tie registrations to specific authenticators. User agents MUST NOT provide such an attestation unless the user agent or authenticator configuration permits it for the requested RP ID. If permitted, the user agent SHOULD signal to the authenticator (at invocation time) that enterprise attestation is requested, and convey the resulting AAGUID and attestation statement, unaltered, to the Relying Party."
},
"PreferIndirectAttestation": {
"const": "indirect",
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem."
},
"PreferNoAttestation": {
"const": "none",
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified."
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"anyOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"default": "#/$defs/PreferNoAttestation",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": "#/$defs/UserVerificationPreferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"const": "public-key",
"description": "Credential type for WebAuthn."
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"description": "When this data expires",
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Contains additional parameters requesting additional processing by the client and authenticator."
},
"userVerification": {
"anyOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"default": "#/$defs/UserVerificationPreferred",
"description": "Required user verification in this login or registration ceremony.",
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration for either registration or login.",
"properties": {
"Enforce": {
"description": "Enforce the timeouts at the Relying Party / Server. This means if enabled and the user takes too long that even if the browser does not enforce the timeout the Relying Party / Server will.",
"type": "boolean"
},
"Timeout": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to anything other than discouraged.",
"type": "integer"
},
"TimeoutUVD": {
"description": "The timeout in nanoseconds for logins/registrations when the UserVerificationRequirement is set to discouraged.",
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"description": "Represents the WebAuthn timeouts configuration.",
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for login."
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig",
"description": "Timeouts for registration."
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"TransportBLE": {
"const": "ble",
"description": "Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE)."
},
"TransportHybrid": {
"const": "hybrid",
"description": "Indicates the respective authenticator can be contacted using a combination of (often separate) data-transport and proximity mechanisms. This supports, for example, authentication on a desktop computer using a smartphone."
},
"TransportInternal": {
"const": "internal",
"description": "Indicates the respective authenticator is contacted using a client device-specific transport, i.e., it is a platform authenticator. These authenticators are not removable from the client device."
},
"TransportNFC": {
"const": "nfc",
"description": "Indicates the respective authenticator can be contacted over Near Field Communication (NFC)."
},
"TransportUSB": {
"const": "usb",
"description": "Indicates the respective authenticator can be contacted over removable USB"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"description": "URL-encoded base64 data.",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "@deprecated This has been removed from the specification recommendation. Suggest a blank string.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "@deprecated This has been removed from the specification recommendations.",
"type": "string"
},
"id": {
"description": "The user handle of the user account. *//* eslint-disable-next-line @typescript-eslint/no-explicit-any"
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"const": "discouraged",
"description": "The authenticator should not verify the user for the credential."
},
"UserVerificationPreferred": {
"const": "preferred",
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified."
},
"UserVerificationRequired": {
"const": "required",
"description": "User verification is required to create/use a credential."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | c5aba376431ec68d90d149a3ba493f32de439db2 | 2020-07-05T22:24:27 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"additionalProperties": false,
"definitions": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"signature": {
"description": "The raw signature returned from the authenticator.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"userHandle": {
"description": "Contains the Relying Party's ID for the user",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"clientDataJSON": {
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create().",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/definitions/PlatformAttachment"
},
{
"$ref": "#/definitions/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/definitions/UserVerificationRequired"
},
{
"$ref": "#/definitions/UserVerificationPreferred"
},
{
"$ref": "#/definitions/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/definitions/PreferNoAttestation"
},
{
"$ref": "#/definitions/PreferIndirectAttestation"
},
{
"$ref": "#/definitions/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
}
},
"required": [
"RPDisplayName",
"RPID"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/definitions/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"ID": {
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"PublicKey": {
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/definitions/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration.",
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"response": {
"$ref": "#/definitions/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"description": "The ID of a credential to allow/disallow.",
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the relying party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms)",
"oneOf": [
{
"$ref": "#/definitions/AlgES256"
},
{
"$ref": "#/definitions/AlgES384"
},
{
"$ref": "#/definitions/AlgES512"
},
{
"$ref": "#/definitions/AlgRS1"
},
{
"$ref": "#/definitions/AlgRS256"
},
{
"$ref": "#/definitions/AlgRS384"
},
{
"$ref": "#/definitions/AlgRS512"
},
{
"$ref": "#/definitions/AlgPS256"
},
{
"$ref": "#/definitions/AlgPS384"
},
{
"$ref": "#/definitions/AlgPS512"
},
{
"$ref": "#/definitions/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/definitions/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/definitions/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"excludeCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"pubKeyCredParams": {
"items": {
"$ref": "#/definitions/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/definitions/RelyingPartyEntity"
},
"timeout": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/UserEntity"
}
},
"required": [
"challenge",
"rp",
"user"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "FOOBAR",
"properties": {
"allowCredentials": {
"items": {
"$ref": "#/definitions/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"extensions": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"rpId": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"userVerification": {
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"properties": {
"allowed_credentials": {
"items": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"type": "array"
},
"challenge": {
"type": "string"
},
"userVerification": {
"type": "string"
},
"user_id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"userVerification"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"credentials": {
"items": {
"$ref": "#/definitions/Credential"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"iconURL": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"properties": {
"Config": {
"$ref": "#/definitions/Config"
},
"CredentialAssertion": {
"$ref": "#/definitions/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/definitions/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/definitions/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/definitions/CredentialCreationResponse"
},
"SessionData": {
"$ref": "#/definitions/SessionData"
},
"User": {
"$ref": "#/definitions/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData"
],
"type": "object"
} | MIT | en |
davedoesdev/webauthn4js | 21935f379ba3b6dd85b77aee8afee33f0f9eaae9 | 2023-12-13T21:07:05 | schemas/schemas.json | 22 | 2024-05-28T04:56:47.07851Z | {
"$defs": {
"AlgES256": {
"description": "ECDSA with SHA-256",
"enum": [
-7
]
},
"AlgES384": {
"description": "ECDSA with SHA-384",
"enum": [
-35
]
},
"AlgES512": {
"description": "ECDSA with SHA-512",
"enum": [
-36
]
},
"AlgEdDSA": {
"description": "EdDSA",
"enum": [
-8
]
},
"AlgPS256": {
"description": "RSASSA-PSS with SHA-256",
"enum": [
-37
]
},
"AlgPS384": {
"description": "RSASSA-PSS with SHA-384",
"enum": [
-38
]
},
"AlgPS512": {
"description": "RSASSA-PSS with SHA-512",
"enum": [
-39
]
},
"AlgRS1": {
"description": "RSASSA-PKCS1-v1_5 with SHA-1",
"enum": [
-65535
]
},
"AlgRS256": {
"description": "RSASSA-PKCS1-v1_5 with SHA-256",
"enum": [
-257
]
},
"AlgRS384": {
"description": "RSASSA-PKCS1-v1_5 with SHA-384",
"enum": [
-258
]
},
"AlgRS512": {
"description": "RSASSA-PKCS1-v1_5 with SHA-512",
"enum": [
-259
]
},
"AuthenticationExtensions": {
"description": "Contains additional parameters requesting additional processing by the client and authenticator.",
"type": "object"
},
"AuthenticationExtensionsClientOutputs": {
"type": "object"
},
"Authenticator": {
"additionalProperties": false,
"description": "Represents the user's authenticator device.",
"properties": {
"AAGUID": {
"contentEncoding": "base64",
"description": "Identifies the type (e.g. make and model) of the authenticator.",
"type": "string"
},
"Attachment": {
"type": "string"
},
"CloneWarning": {
"description": "This is a signal that the authenticator may be cloned, i.e. at least two copies of the credential private key may exist and are being used in parallel. Relying Parties (applications) should incorporate this information into their risk scoring. Whether the Relying Party updates the stored signature counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific.",
"type": "boolean"
},
"SignCount": {
"description": "{@link WebAuthn4JS.finishLogin} compares the stored signature counter value with the new `signCount` value returned in the assertion\u2019s authenticator data. If this new `signCount` value is less than or equal to the stored value, a cloned authenticator may exist, or the authenticator may be malfunctioning.",
"type": "integer"
}
},
"required": [
"AAGUID",
"SignCount",
"CloneWarning",
"Attachment"
],
"type": "object"
},
"AuthenticatorAssertionResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator assertion data, used to verify the authenticity of the login ceremony and the used credential.",
"properties": {
"authenticatorData": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Serialized bindings made by the authenticator, such as ID of the Relying Party that the credential is meant for, whether the user is present and the signature count."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.get()."
},
"signature": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The raw signature returned from the authenticator."
},
"userHandle": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains the Relying Party's ID for the user"
}
},
"required": [
"clientDataJSON",
"authenticatorData",
"signature"
],
"type": "object"
},
"AuthenticatorAttestationResponse": {
"additionalProperties": false,
"description": "Contains the raw authenticator attestation data, used to verify the authenticy of the registration ceremony and the new credential.",
"properties": {
"attestationObject": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "This attribute contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the browser. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data."
},
"clientDataJSON": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "Contains a JSON serialization of the client data passed to the authenticator by the browser in its call to navigator.credentials.create()."
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"clientDataJSON",
"attestationObject"
],
"type": "object"
},
"AuthenticatorSelection": {
"additionalProperties": false,
"description": "Use this class to specify requirements regarding authenticator attributes.",
"properties": {
"authenticatorAttachment": {
"description": "If this member is present, eligible authenticators are filtered to only authenticators attached by the specified mechanism.",
"oneOf": [
{
"$ref": "#/$defs/PlatformAttachment"
},
{
"$ref": "#/$defs/CrossPlatformAttachment"
}
],
"type": "string"
},
"requireResidentKey": {
"description": "Describes the Relying Party's requirements regarding resident credentials. If present and set to `true`, the authenticator MUST create a client-side-resident public key credential source when creating a public key credential.",
"type": "boolean"
},
"residentKey": {
"type": "string"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.create()` or `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"description": "Configuration and default values for the {@link WebAuthn4JS} instance.",
"properties": {
"AttestationPreference": {
"default": "none",
"description": "Preferred attestation conveyance during credential generation",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"AuthenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Login requirements for authenticator attributes."
},
"Debug": {
"description": "@ignore",
"type": "boolean"
},
"EncodeUserIDAsString": {
"type": "boolean"
},
"RPDisplayName": {
"description": "Friendly name for the Relying Party (application). The browser may display this to the user.",
"type": "string"
},
"RPID": {
"description": "A valid domain that identifies the Relying Party. A credential can only by used with the same enity (as identified by the `RPID`) it was registered with.",
"type": "string"
},
"RPIcon": {
"description": "URL to an icon representing the Relying Party",
"type": "string"
},
"RPOrigin": {
"description": "The HTTP(S) origin that the Relying Party is using to handle requests",
"type": "string"
},
"RPOrigins": {
"items": {
"type": "string"
},
"type": "array"
},
"Timeout": {
"description": "Timeout for browser `navigator.credentials.create()` and `navigator.credentials.debug()` in the browser.",
"type": "integer"
},
"Timeouts": {
"$ref": "#/$defs/TimeoutsConfig"
}
},
"required": [
"RPID",
"RPDisplayName",
"RPOrigins",
"AttestationPreference",
"AuthenticatorSelection",
"Debug",
"EncodeUserIDAsString",
"Timeouts",
"RPIcon",
"RPOrigin",
"Timeout"
],
"type": "object"
},
"Credential": {
"additionalProperties": false,
"description": "Contains all needed information about a WebAuthn credential for storage.",
"properties": {
"AttestationType": {
"description": "The attestation format used (if any) by the authenticator when creating the credential.",
"type": "string"
},
"Authenticator": {
"$ref": "#/$defs/Authenticator",
"description": "The Authenticator information for a given certificate."
},
"Flags": {
"$ref": "#/$defs/CredentialFlags"
},
"ID": {
"contentEncoding": "base64",
"description": "A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.",
"type": "string"
},
"PublicKey": {
"contentEncoding": "base64",
"description": "The public key portion of a Relying Party-specific credential key pair, generated by an authenticator and returned to a Relying Party at registration time.",
"type": "string"
},
"Transport": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ID",
"PublicKey",
"AttestationType",
"Transport",
"Flags",
"Authenticator"
],
"type": "object"
},
"CredentialAssertion": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the login process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions",
"description": "Options for the browser to pass to `navigator.credentials.get()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialAssertionResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for login.",
"properties": {
"authenticatorAttachment": {
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during login."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAssertionResponse",
"description": "The authenticator's response to the request to generate a login assertion."
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialCreation": {
"additionalProperties": false,
"description": "The payload that should be sent to the browser for beginning the registration process.",
"properties": {
"publicKey": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions",
"description": "Options for the browser to pass to `navigator.credentials.create()`."
}
},
"required": [
"publicKey"
],
"type": "object"
},
"CredentialCreationResponse": {
"additionalProperties": false,
"description": "The raw response returned to us from an authenticator when we request a credential for registration.",
"properties": {
"authenticatorAttachment": {
"type": "string"
},
"clientExtensionResults": {
"$ref": "#/$defs/AuthenticationExtensionsClientOutputs"
},
"extensions": {
"description": "A map containing identifier -> client extension output entries produced by any extensions that may have been used during registration."
},
"id": {
"description": "The credential's identifier.",
"type": "string"
},
"rawId": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The credential's identifier. Since we base64-encode raw data, this is the same as `id`."
},
"response": {
"$ref": "#/$defs/AuthenticatorAttestationResponse",
"description": "The authenticator's response to the request to generate a registration attestation."
},
"transports": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Specifies the credential type represented by this object.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"id",
"type",
"rawId",
"response"
],
"type": "object"
},
"CredentialDescriptor": {
"additionalProperties": false,
"description": "Specifies a credential for use by the browser when it calls `navigator.credentials.create()` or `navigator.credentials.get()`.",
"properties": {
"id": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "The ID of a credential to allow/disallow."
},
"transports": {
"description": "Contains a hint as to how the browser might communicate with the authenticator to which the credential belongs.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CredentialFlags": {
"additionalProperties": false,
"properties": {
"BackupEligible": {
"type": "boolean"
},
"BackupState": {
"type": "boolean"
},
"UserPresent": {
"type": "boolean"
},
"UserVerified": {
"type": "boolean"
}
},
"required": [
"UserPresent",
"UserVerified",
"BackupEligible",
"BackupState"
],
"type": "object"
},
"CredentialParameter": {
"additionalProperties": false,
"description": "The credential type and algorithm that the Relying Party wants the authenticator to create.",
"properties": {
"alg": {
"description": "Algorithm to use, see the [IANA CBOR COSE Algorithms Registry](https://www.iana.org/assignments/cose/cose.xhtml#algorithms).",
"oneOf": [
{
"$ref": "#/$defs/AlgES256"
},
{
"$ref": "#/$defs/AlgES384"
},
{
"$ref": "#/$defs/AlgES512"
},
{
"$ref": "#/$defs/AlgRS1"
},
{
"$ref": "#/$defs/AlgRS256"
},
{
"$ref": "#/$defs/AlgRS384"
},
{
"$ref": "#/$defs/AlgRS512"
},
{
"$ref": "#/$defs/AlgPS256"
},
{
"$ref": "#/$defs/AlgPS384"
},
{
"$ref": "#/$defs/AlgPS512"
},
{
"$ref": "#/$defs/AlgEdDSA"
}
],
"type": "integer"
},
"type": {
"description": "Type of the credential to use.",
"oneOf": [
{
"$ref": "#/$defs/PublicKeyCredentialType"
}
],
"type": "string"
}
},
"required": [
"type",
"alg"
],
"type": "object"
},
"CrossPlatformAttachment": {
"description": "A roaming authenticator is attached using cross-platform transports, called cross-platform attachment. Authenticators of this class are removable from, and can \"roam\" among, client devices. A public key credential bound to a roaming authenticator is called a roaming credential.",
"enum": [
"cross-platform"
]
},
"PlatformAttachment": {
"description": "A platform authenticator is attached using a client device-specific transport, called platform attachment, and is usually not removable from the client device. A public key credential bound to a platform authenticator is called a platform credential.",
"enum": [
"platform"
]
},
"PreferDirectAttestation": {
"description": "Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.",
"enum": [
"direct"
]
},
"PreferIndirectAttestation": {
"description": "Indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user\u2019s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.",
"enum": [
"indirect"
]
},
"PreferNoAttestation": {
"description": "Indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA. This is the default if no attestation conveyance is specified.",
"enum": [
"none"
]
},
"PublicKeyCredentialCreationOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.create()`.",
"properties": {
"attestation": {
"default": "none",
"description": "This member is intended for use by Relying Parties that wish to express their preference for attestation conveyance.",
"oneOf": [
{
"$ref": "#/$defs/PreferNoAttestation"
},
{
"$ref": "#/$defs/PreferIndirectAttestation"
},
{
"$ref": "#/$defs/PreferDirectAttestation"
}
],
"type": "string"
},
"authenticatorSelection": {
"$ref": "#/$defs/AuthenticatorSelection",
"description": "Registration requirements for authenticator attributes."
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge intended to be used for generating the newly created credential\u2019s attestation."
},
"excludeCredentials": {
"description": "This member is intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The browser is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in [WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions); consult the IANA \"WebAuthn Extension Identifier\" registry established by [WebAuthn-Registries](https://tools.ietf.org/html/draft-hodges-webauthn-registries) for an up-to-date list of registered WebAuthn Extensions."
},
"pubKeyCredParams": {
"description": " Information about the desired properties of the credential to be created. The sequence is ordered from most preferred to least preferred. The browser makes a best-effort to create the most preferred credential that it can.",
"items": {
"$ref": "#/$defs/CredentialParameter"
},
"type": "array"
},
"rp": {
"$ref": "#/$defs/RelyingPartyEntity",
"description": "Data about the Relying Party responsible for the request (i.e. your application)"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"user": {
"$ref": "#/$defs/UserEntity",
"description": "Data about the user account for which the Relying Party is requesting attestation."
}
},
"required": [
"rp",
"user",
"challenge"
],
"type": "object"
},
"PublicKeyCredentialRequestOptions": {
"additionalProperties": false,
"description": "Parameters for `navigator.credentials.get()`.",
"properties": {
"allowCredentials": {
"description": "A list of public key credentials acceptable to the caller, in descending order of preference (the first item in the list is the most preferred credential, and so on down the list).",
"items": {
"$ref": "#/$defs/CredentialDescriptor"
},
"type": "array"
},
"challenge": {
"$ref": "#/$defs/URLEncodedBase64",
"description": "A challenge that the selected authenticator signs, along with other data, when producing a login assertion."
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions",
"description": "Additional parameters requesting additional processing by the browser and authenticator. For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension."
},
"rpId": {
"description": "Specifies the Relying Party identifier claimed by the application. If omitted, its value will be the application's origin's effective domain.",
"type": "string"
},
"timeout": {
"description": "Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the browser.",
"type": "integer"
},
"userVerification": {
"default": "preferred",
"description": "Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
}
},
"required": [
"challenge"
],
"type": "object"
},
"PublicKeyCredentialType": {
"description": "Credential type for WebAuthn.",
"enum": [
"public-key"
]
},
"RelyingPartyEntity": {
"additionalProperties": false,
"description": "Used to supply additional Relying Party attributes when creating a new credential.",
"properties": {
"icon": {
"description": "A URL which resolves to an image associated with the Relying Party, for example its logo.",
"type": "string"
},
"id": {
"description": "A unique identifier for the Relying Party.",
"type": "string"
},
"name": {
"description": "A human-palatable identifier for the Relying Party, intended only for display.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"SessionData": {
"additionalProperties": false,
"description": "Data that should be stored securely (anti-tamper) by the Relying Party for the duration of the registration or login ceremony.",
"properties": {
"allowed_credentials": {
"description": "Credentials allowed in this login or registration ceremony.",
"items": {
"contentEncoding": "base64",
"type": "string"
},
"type": "array"
},
"challenge": {
"description": "Challenge that was sent to the browser.",
"type": "string"
},
"expires": {
"format": "date-time",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/AuthenticationExtensions"
},
"userVerification": {
"default": "preferred",
"description": "Required user verification in this login or registration ceremony.",
"oneOf": [
{
"$ref": "#/$defs/UserVerificationRequired"
},
{
"$ref": "#/$defs/UserVerificationPreferred"
},
{
"$ref": "#/$defs/UserVerificationDiscouraged"
}
],
"type": "string"
},
"user_id": {
"contentEncoding": "base64",
"description": "ID of the user being registered or logged in.",
"type": "string"
}
},
"required": [
"challenge",
"user_id",
"expires",
"userVerification"
],
"type": "object"
},
"TimeoutConfig": {
"additionalProperties": false,
"properties": {
"Enforce": {
"type": "boolean"
},
"Timeout": {
"type": "integer"
},
"TimeoutUVD": {
"type": "integer"
}
},
"required": [
"Enforce",
"Timeout",
"TimeoutUVD"
],
"type": "object"
},
"TimeoutsConfig": {
"additionalProperties": false,
"properties": {
"Login": {
"$ref": "#/$defs/TimeoutConfig"
},
"Registration": {
"$ref": "#/$defs/TimeoutConfig"
}
},
"required": [
"Login",
"Registration"
],
"type": "object"
},
"URLEncodedBase64": {
"contentEncoding": "base64",
"type": "string"
},
"User": {
"additionalProperties": false,
"description": "Represents an application (Relying Party) user.",
"properties": {
"credentials": {
"description": "Credentials owned by the user.",
"items": {
"$ref": "#/$defs/Credential"
},
"type": "array"
},
"displayName": {
"description": "Display Name of the user.",
"type": "string"
},
"iconURL": {
"description": "User's icon url.",
"type": "string"
},
"id": {
"contentEncoding": "base64",
"description": "User ID according to the Relying Party.",
"type": "string"
},
"name": {
"description": "User Name according to the Relying Party.",
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"iconURL",
"credentials"
],
"type": "object"
},
"UserEntity": {
"additionalProperties": false,
"description": "Supplies additional user account attributes when creating a new credential.",
"properties": {
"displayName": {
"description": "A human-palatable name for the user account, intended only for display.",
"type": "string"
},
"icon": {
"description": "A URL which resolves to an image associated with the user account.",
"type": "string"
},
"id": {
"description": "The user handle of the user account."
},
"name": {
"description": "A human-palatable identifier for the user account, intended only for display to aid the user in determining the difference between user accounts with similar `displayName`s.",
"type": "string"
}
},
"required": [
"name",
"id"
],
"type": "object"
},
"UserVerificationDiscouraged": {
"description": "The authenticator should not verify the user for the credential.",
"enum": [
"discouraged"
]
},
"UserVerificationPreferred": {
"description": "User verification is preferred to create/use a credential. This is the default if no user verification requirement is specified.",
"enum": [
"preferred"
]
},
"UserVerificationRequired": {
"description": "User verification is required to create/use a credential.",
"enum": [
"required"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Config": {
"$ref": "#/$defs/Config"
},
"Credential": {
"$ref": "#/$defs/Credential"
},
"CredentialAssertion": {
"$ref": "#/$defs/CredentialAssertion"
},
"CredentialAssertionResponse": {
"$ref": "#/$defs/CredentialAssertionResponse"
},
"CredentialCreation": {
"$ref": "#/$defs/CredentialCreation"
},
"CredentialCreationResponse": {
"$ref": "#/$defs/CredentialCreationResponse"
},
"CredentialDescriptor": {
"$ref": "#/$defs/CredentialDescriptor"
},
"PublicKeyCredentialCreationOptions": {
"$ref": "#/$defs/PublicKeyCredentialCreationOptions"
},
"PublicKeyCredentialRequestOptions": {
"$ref": "#/$defs/PublicKeyCredentialRequestOptions"
},
"SessionData": {
"$ref": "#/$defs/SessionData"
},
"User": {
"$ref": "#/$defs/User"
}
},
"required": [
"Config",
"User",
"CredentialCreation",
"CredentialCreationResponse",
"CredentialAssertion",
"CredentialAssertionResponse",
"SessionData",
"Credential",
"CredentialDescriptor",
"PublicKeyCredentialCreationOptions",
"PublicKeyCredentialRequestOptions"
],
"type": "object"
} | MIT | en |
decodableco/examples | 45e415476da1494f01d181a55d9015b7f8a6e108 | 2022-05-12T12:12:33 | opinionated-pipelines/schemas/employee.json | 43 | 2024-05-27T05:51:57.697813Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "An employee in your company",
"properties": {
"SSN": {
"description": "Identifier that is not a SSN",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"empid": {
"description": "Identifier that is not a SSN",
"type": "integer"
},
"fname": {
"description": "First name",
"type": "string"
},
"lname": {
"description": "Last name",
"type": "string"
}
},
"required": [
"empid",
"SSN",
"fname",
"lname",
"address"
],
"title": "Employee",
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | de1f04fde9b172572dbdb899168cef12a3f860b3 | 2023-02-16T10:10:19 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where properties are required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringLong": {
"description": "Here's a string field with a very long title and a very long description. Notice how long the title and the description for this string field is. The title and the description for this string field are both significantly longer than the title and the description for the other fields in this form.",
"title": "String field with a very long title and a very long description that require special handling and treatment so that its display in the form is optimized",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 846c3cf1a116e9463cbc03a86bd8cf802c887b13 | 2023-02-07T13:21:32 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where properties are required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 929711514056d9925ed7591fddab035f25cb339e | 2023-05-03T13:38:00 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"additionalProperties": {
"properties": {
"objectOfIntegers": {
"additionalProperties": {
"type": "integer"
},
"title": "Object of integers",
"type": "object"
},
"objectOfObjects": {
"additionalProperties": {
"properties": {
"instanceType": {
"title": "Instance type",
"type": "string"
},
"maxSize": {
"title": "Maximum number of nodes",
"type": "integer"
},
"minSize": {
"title": "Minimum number of nodes",
"type": "integer"
}
},
"title": "Node pool",
"type": "object"
},
"title": "Object of objects",
"type": "object"
},
"objectOfObjectsWithDefault": {
"additionalProperties": {
"properties": {
"instanceType": {
"title": "Instance type",
"type": "string"
},
"maxSize": {
"title": "Maximum number of nodes",
"type": "integer"
},
"minSize": {
"title": "Minimum number of nodes",
"type": "integer"
}
},
"title": "Node pool",
"type": "object"
},
"title": "Object of objects with default value",
"type": "object"
},
"objectOfStrings": {
"additionalProperties": {
"type": "string"
},
"title": "Object of strings",
"type": "object"
}
},
"title": "Additional properties",
"type": "object"
},
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"internal": {
"properties": {
"additionalProperties": {
"properties": {
"objectOfObjectsWithDefault": {
"default": {
"def00": {
"instanceType": "m5.xlarge",
"minSize": 3
}
},
"type": "object"
}
},
"type": "object"
},
"patternProperties": {
"properties": {
"objectOfObjectsWithDefault": {
"default": {
"def00": {
"instanceType": "m5.xlarge",
"minSize": 3
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must match one of the patterns - ^[a-z]$ or ^[0-9]$.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"pattern": "^[0-9]$"
}
],
"title": "String matching multiple patterns",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where properties are required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"patternProperties": {
"properties": {
"objectOfIntegers": {
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"type": "integer"
}
},
"title": "Object of integers",
"type": "object"
},
"objectOfObjects": {
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"properties": {
"instanceType": {
"title": "Instance type",
"type": "string"
},
"maxSize": {
"title": "Maximum number of nodes",
"type": "integer"
},
"minSize": {
"title": "Minimum number of nodes",
"type": "integer"
}
},
"title": "Node pool",
"type": "object"
}
},
"title": "Object of objects",
"type": "object"
},
"objectOfObjectsWithDefault": {
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"properties": {
"instanceType": {
"title": "Instance type",
"type": "string"
},
"maxSize": {
"title": "Maximum number of nodes",
"type": "integer"
},
"minSize": {
"title": "Minimum number of nodes",
"type": "integer"
}
},
"title": "Node pool",
"type": "object"
}
},
"title": "Object of objects with default value",
"type": "object"
},
"objectOfStrings": {
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"type": "string"
}
},
"title": "Object of strings",
"type": "object"
}
},
"title": "Pattern properties",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringLong": {
"description": "Here's a string field with a very long title and a very long description. Notice how long the title and the description for this string field is. The title and the description for this string field are both significantly longer than the title and the description for the other fields in this form.",
"title": "String field with a very long title and a very long description that require special handling and treatment so that its display in the form is optimized",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 2f85391232e0a9281afdb7698e4ecabbef9bd4b0 | 2023-01-25T15:59:21 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"boolean": {
"description": "Boolean field with title and description.",
"title": "Boolean",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where one property is required.",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 486e745b87e77036a0fa730723da0016e1488bc7 | 2023-02-02T06:39:18 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where one property is required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 250299e31fd540afbf289c48800678dcbe98f72b | 2023-02-17T09:56:43 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must match one of the patterns - ^[a-z]$ or ^[0-9]$.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"pattern": "^[0-9]$"
}
],
"title": "String matching multiple patterns",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where properties are required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringLong": {
"description": "Here's a string field with a very long title and a very long description. Notice how long the title and the description for this string field is. The title and the description for this string field are both significantly longer than the title and the description for the other fields in this form.",
"title": "String field with a very long title and a very long description that require special handling and treatment so that its display in the form is optimized",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 1f3f2b772efee5426796d0c3d99b8bae42f0210d | 2023-02-02T15:12:25 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where one property is required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | facb6825486c74f8cf6037b6a972a87387286d2a | 2023-02-01T15:12:37 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"boolean": {
"description": "Boolean field with title and description.",
"title": "Boolean",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where one property is required.",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 9a0ebf7328eab9dcc38c06dfd123b4da092d1426 | 2023-01-26T13:59:25 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "http://json-schema.org/schema#",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"boolean": {
"description": "Boolean field with title and description.",
"title": "Boolean",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where one property is required.",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
giantswarm/happa | 6c66bb28fd9592a46751c76b50e305fa9da46e0c | 2023-02-08T17:00:02 | src/components/UI/JSONSchemaForm/test.schema.json | 21 | 2024-05-28T03:52:43.79711Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"arrayFields": {
"properties": {
"arrayMinMaxItems": {
"description": "Array with the minimum and maximum number of items",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Array with min/max items",
"type": "array"
},
"arrayOfObjects": {
"items": {
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"title": "Array of objects",
"type": "array"
},
"arrayOfObjectsWithTitle": {
"items": {
"description": "Description of array item object",
"properties": {
"age": {
"type": "number"
},
"name": {
"type": "string"
}
},
"title": "Array item object",
"type": "object"
},
"title": "Array of objects with title",
"type": "array"
},
"arrayOfStrings": {
"items": {
"type": "string"
},
"title": "Array of strings",
"type": "array"
}
},
"title": "Array fields",
"type": "object"
},
"booleanFields": {
"properties": {
"active": {
"type": "boolean"
},
"enabled": {
"description": "Boolean field with title and description.",
"title": "Enabled",
"type": "boolean"
}
},
"title": "Boolean fields",
"type": "object"
},
"logic": {
"description": "Uses of 'anyOf', 'oneOf', and 'not'.",
"properties": {
"anyOf": {
"properties": {
"anyOfDeprecated": {
"anyOf": [
{
"deprecated": true,
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the second declared subschema (number, minimum=3) should be visible.",
"title": "Property with subschemas using 'anyOf' and 'deprecated'"
},
"anyOfSimple": {
"anyOf": [
{
"minLength": 3,
"type": "string"
},
{
"minimum": 3,
"type": "number"
}
],
"description": "Only the first declared subschema (string, minLength=3) should be visible.",
"title": "Property with two subschemas using 'anyOf'"
}
},
"title": "Subschema choice using 'anyOf'",
"type": "object"
},
"not": {
"properties": {
"stringNot": {
"description": "Value must not be 'forbidden'.",
"not": {
"const": "forbidden"
},
"title": "String with constraints defined via 'not'",
"type": "string"
}
},
"title": "Constraints defined via 'not'",
"type": "object"
},
"oneOf": {
"properties": {
"stringPatternOrEmpty": {
"description": "Value must either match a pattern ^[a-z]$ or be empty.",
"oneOf": [
{
"pattern": "^[a-z]$"
},
{
"const": ""
}
],
"title": "String matching pattern or empty",
"type": "string"
}
},
"title": "Subschema choice using 'oneOf'",
"type": "object"
}
},
"title": "Logic and subschemas",
"type": "object"
},
"numericFields": {
"properties": {
"integer": {
"description": "Integer field with title and description.",
"title": "Integer",
"type": "integer"
},
"integerEnum": {
"description": "Integer field with enumerated values and custom labels.",
"oneOf": [
{
"const": 1,
"title": "One"
},
{
"const": 2,
"title": "Two"
},
{
"const": 3,
"title": "Three"
}
],
"title": "Integer enum",
"type": "integer"
},
"integerLimit": {
"description": "Integer field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Integer with min/max values",
"type": "integer"
},
"number": {
"description": "Number field with title and description.",
"title": "Number",
"type": "number"
},
"numberLimit": {
"description": "Number field with minimum value 2 and maximum value 5.",
"maximum": 5,
"minimum": 2,
"title": "Number with min/max values",
"type": "number"
}
},
"title": "Numeric fields",
"type": "object"
},
"objectFields": {
"properties": {
"object": {
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"title": "Object",
"type": "object"
},
"objectRequired": {
"description": "Object where properties are required.",
"properties": {
"active": {
"type": "boolean"
},
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"active",
"name"
],
"title": "Object with required",
"type": "object"
}
},
"title": "Object fields",
"type": "object"
},
"stringFields": {
"properties": {
"string": {
"description": "String field with title and description.",
"title": "String",
"type": "string"
},
"stringCustomLabels": {
"description": "String field with enumerated values and custom labels.",
"oneOf": [
{
"const": "firstValue",
"title": "First Value"
},
{
"const": "secondValue",
"title": "Second Value"
},
{
"const": "thirdValue",
"title": "Third Value"
}
],
"title": "String enum with custom labels",
"type": "string"
},
"stringEnum": {
"description": "String field with enumerated values.",
"enum": [
"firstValue",
"secondValue",
"thirdValue"
],
"title": "String enum",
"type": "string"
},
"stringFormat": {
"description": "String field with format 'ipv4'.",
"format": "ipv4",
"title": "String with format",
"type": "string"
},
"stringLength": {
"description": "String field with minLength and maxLength validation. Submit the form to see validation errors.",
"maxLength": 5,
"minLength": 2,
"title": "String with min/max length",
"type": "string"
},
"stringPattern": {
"description": "String field with pattern validation for regular expression '^[a-z0-9]{10,20}$'.",
"pattern": "^[a-z0-9]{10,20}$",
"title": "String with pattern",
"type": "string"
}
},
"title": "String fields",
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/animated-properties/keyframe.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"s": {
"description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
"items": {
"type": "number"
},
"title": "Value",
"type": "array"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"h": {
"const": 0
}
}
},
{
"not": {
"required": [
"h"
]
}
}
]
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "A Keyframes specifies the value at a specific time and the interpolation function to reach the next keyframe.",
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 14836b59575d38fe92928f008000d27d89e36b67 | 2021-10-24T09:39:09 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ao": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Auto Orient"
},
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"cl": {
"description": "CSS class used by the SVG renderer",
"title": "Class",
"type": "string"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the layer is threedimensional",
"title": "Threedimensional"
},
"ef": {
"items": {
"oneOf": [
{
"$ref": "#/$defs/effects/change-to-color-effect"
},
{
"$ref": "#/$defs/effects/drop-shadow-effect"
},
{
"$ref": "#/$defs/effects/fill-effect"
},
{
"$ref": "#/$defs/effects/gaussian-blur-effect"
},
{
"$ref": "#/$defs/effects/matte3-effect"
},
{
"$ref": "#/$defs/effects/pro-levels-effect"
},
{
"$ref": "#/$defs/effects/stroke-effect"
},
{
"$ref": "#/$defs/effects/tint-effect"
},
{
"$ref": "#/$defs/effects/tritone-effect"
}
]
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"description": "Whether the layer has masks applied",
"title": "Has Masks",
"type": "boolean"
},
"hd": {
"description": "Whether the layer is hidden",
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"description": "Frame when the layers becomes visible",
"title": "In Point",
"type": "number"
},
"ks": {
"$ref": "#/$defs/helpers/transform",
"description": "Layer transform",
"title": "Transform"
},
"ln": {
"description": "`id` attribute used by the SVG renderer",
"title": "Layer XML ID",
"type": "string"
},
"masksProperties": {
"items": {
"$ref": "#/$defs/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"op": {
"description": "Frame when the layers becomes invisible",
"title": "Out Point",
"type": "number"
},
"parent": {
"description": "Must be the `ind` property of another layer",
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Time Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/$defs/constants/matte-mode",
"title": "Matte Mode"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op",
"ks"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/constants/text-shape.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 1,
"title": "Square"
},
{
"const": 2,
"title": "Ramp Up"
},
{
"const": 3,
"title": "Ramp Down"
},
{
"const": 4,
"title": "Triangle"
},
{
"const": 5,
"title": "Round"
},
{
"const": 6,
"title": "Smooth"
}
],
"title": "Text Shape",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8db5fd8882acc77810b606c1402edd3449a98219 | 2022-07-10T17:49:09 | docs/schema/shapes/offset-path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Amount"
},
"lj": {
"$ref": "#/$defs/constants/line-join",
"default": 2,
"title": "Line Join"
},
"ml": {
"$ref": "#/$defs/animated-properties/value",
"title": "Miter Limit"
},
"ty": {
"const": "op",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "shape-offset-path",
"description": "Interpolates the shape with its center point and bezier tangents with the opposite direction",
"title": "Offset Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8362bdd4ad1eaef21e98f05d78b011c64ef57fbb | 2021-10-22T09:59:40 | docs/schema/effects/pro-levels-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effects/effect-value-drop-down",
"title": "00"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "01"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "02"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "comp_inblack"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "comp_inwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "comp_gamma"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "comp_outblack"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "comp_outwhite"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "08"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "09"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "r_inblack"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "r_inwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "r_gamma"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "r_outblack"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "r_outwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "15"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "16"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "g_inblack"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "g_inwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "g_gamma"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "g_outblack"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "g_outwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "22"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "b3"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "b_inblack"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "b_inwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "b_gamma"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "b_outblack"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "b_outwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "29"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "a_inblack"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "a_inwhite"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "a_gamma"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "a_outblack"
},
{
"$ref": "#/$defs/effects/effect-no-value",
"title": "a_outwhite"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 24,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Pro Levels Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/line-cap.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Style at the end of a stoked line",
"oneOf": [
{
"const": 1,
"title": "Butt"
},
{
"const": 2,
"title": "Round"
},
{
"const": 3,
"title": "Square"
}
],
"title": "LineCap",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 928ea47b57dd9763190f114250d133a7edc1e8bb | 2022-07-13T13:02:49 | docs/schema/shapes/zig-zag.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"pt": {
"$ref": "#/$defs/animated-properties/value",
"description": "Type of points",
"title": "Points"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"description": "Number of ridges per segment",
"title": "Frequency"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"description": "Distance between peaks and troughs",
"title": "Amplitude"
},
"ty": {
"const": "zz",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Changes the edges of affected shapes into a series of peaks and valleys of uniform size",
"title": "Zig Zags",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d4d7b11657e01d91f05f85207c991f040565d18b | 2022-05-20T09:36:32 | docs/schema/styles/color-overlay-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"so": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"ty": {
"const": 7,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"title": "Color Overlay",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/constants/text-caps.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": 0,
"oneOf": [
{
"const": 0,
"title": "Regular"
},
{
"const": 1,
"title": "All Caps"
},
{
"const": 2,
"title": "Small Caps"
}
],
"title": "TextCaps",
"type": "number"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | bc9a3f40c7bbf65091fcc23505f5e641bd1e6527 | 2022-07-09T16:10:00 | docs/schema/shapes/stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"description": "Stroke color",
"title": "Color"
},
"ty": {
"const": "st",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"c"
],
"type": "object"
}
],
"caniuse": "shape-stroke",
"description": "Solid stroke",
"title": "Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/shapes/merge.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"mm": {
"default": 1,
"title": "Merge Mode",
"type": "number"
},
"ty": {
"const": "mm",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Merge",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/shapes/offset-path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Amount"
},
"lj": {
"$ref": "#/$defs/constants/line-join",
"default": 2,
"title": "Line Join"
},
"ml": {
"$ref": "#/$defs/animated-properties/value",
"title": "Miter Limit",
"type": "number"
},
"ty": {
"const": "op",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "shape-offset-path",
"description": "Interpolates the shape with its center point and bezier tangents with the opposite direction",
"title": "Offset Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/styles/color-overlay-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"so": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"ty": {
"const": 7,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "style-color-overlay",
"title": "Color Overlay",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/constants/text-based.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 1,
"title": "Characters"
},
{
"const": 2,
"title": "Character Excluding Spaces"
},
{
"const": 3,
"title": "Words"
},
{
"const": 4,
"title": "Lines"
}
],
"title": "Text Based",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 3d0dc7ddeabd27ff702d3752ef3edc5b69632be6 | 2021-10-19T06:19:05 | docs/schema/text/text-document.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Note that for multi-line text, lines are separated by \\r",
"properties": {
"f": {
"default": "",
"title": "Font Family",
"type": "string"
},
"fc": {
"$ref": "#/$defs/types/color",
"default": [
0,
0,
0
],
"title": "Font Color"
},
"j": {
"$ref": "#/$defs/constants/text-justify",
"default": 0,
"title": "Justify"
},
"lh": {
"title": "Line Height",
"type": "number"
},
"s": {
"default": 10,
"title": "Font Size",
"type": "number"
},
"sz": {
"items": {
"type": "number"
},
"title": "Wrap Size",
"type": "array"
},
"t": {
"default": "",
"title": "Text",
"type": "string"
}
},
"required": [],
"title": "Text Document",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/line-join.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Style at a sharp corner of a stoked line",
"oneOf": [
{
"const": 1,
"title": "Miter"
},
{
"const": 2,
"title": "Round"
},
{
"const": 3,
"title": "Bevel"
}
],
"title": "LineJoin",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/animated-properties/keyframe.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"h": {
"const": 0
}
}
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "",
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"s": {
"description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
"items": {
"type": "number"
},
"title": "Value",
"type": "array"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
},
"ti": {
"description": "Tangent for values (eg: moving position around a curved path",
"items": {
"type": "number"
},
"title": "Value In Tangent",
"type": "array"
},
"to": {
"description": "Tangent for values (eg: moving position around a curved path",
"items": {
"type": "number"
},
"title": "Value Out Tangent",
"type": "array"
}
},
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/layers/precomposition-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"h": {
"default": 512,
"title": "Height",
"type": "integer"
},
"refId": {
"default": "",
"title": "Reference Id",
"type": "string"
},
"tm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Time Remapping"
},
"ty": {
"const": 0,
"title": "Type",
"type": "integer"
},
"w": {
"default": 512,
"title": "Width",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Precomposition Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/helpers/visual-object"
},
{
"properties": {
"ao": {
"$ref": "#/types/int-boolean",
"default": 0,
"title": "Auto Orient"
},
"bm": {
"$ref": "#/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"ddd": {
"$ref": "#/types/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"ef": {
"item": {
"$ref": "#/effects/effect"
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"title": "Has Masks",
"type": "boolean"
},
"hd": {
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"title": "In Point",
"type": "number"
},
"ks": {
"$ref": "#/helpers/transform",
"title": "Transform"
},
"masksProperties": {
"item": {
"$ref": "#/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"op": {
"title": "Out Point",
"type": "number"
},
"parent": {
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/constants/matte-mode",
"title": "Matte Mode"
},
"ty": {
"title": "Type",
"type": "integer"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/helpers/transform.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Anchor Point"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"p": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Position"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Rotation"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Scale"
},
"sa": {
"$ref": "#/$defs/animated-properties/value",
"title": "Skew Axis"
},
"sk": {
"$ref": "#/$defs/animated-properties/value",
"title": "Skew"
}
},
"required": [],
"type": "object"
}
],
"description": "Layer transform",
"title": "Transform",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/layers/shape-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/visual-layer"
},
{
"properties": {
"shapes": {
"$ref": "#/$defs/shapes/shape-list",
"title": "Shapes"
},
"ty": {
"const": 4,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"shapes"
],
"type": "object"
}
],
"caniuse": "layer-shape",
"description": "Layer containing Shapes",
"title": "Shape Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/animated-properties/keyframe.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"h": {
"const": 0
}
}
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "",
"properties": {
"h": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Hold"
},
"s": {
"description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
"items": {
"type": "number"
},
"title": "Value",
"type": "array"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
},
"ti": {
"description": "Tangent for values (eg: moving position around a curved path",
"items": {
"type": "number"
},
"title": "Value In Tangent",
"type": "array"
},
"to": {
"description": "Tangent for values (eg: moving position around a curved path",
"items": {
"type": "number"
},
"title": "Value Out Tangent",
"type": "array"
}
},
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 11d5eafbfc6a08dd41b5f5b465323ab75eca4f81 | 2022-02-17T13:50:48 | docs/schema/animated-properties/position.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the property is animated",
"title": "Animated"
},
"ix": {
"title": "Property Index",
"type": "integer"
},
"x": {
"title": "Expression",
"type": "string"
}
}
},
{
"else": {
"properties": {
"k": {
"items": {
"type": "number"
},
"title": "Static Value",
"type": "array"
}
}
},
"if": {
"properties": {
"a": {
"const": 1
}
}
},
"then": {
"properties": {
"k": {
"description": "Array of keyframes",
"items": {
"$ref": "#/$defs/animated-properties/position-keyframe"
},
"title": "Animated Value",
"type": "array"
}
}
}
}
],
"description": "An animatable property to represent a position in space",
"required": [
"k"
],
"title": "Position Property",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 09f7f2bf9faa628c6728b9bc8bb75d0f79fcce13 | 2021-10-19T15:25:56 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ao": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Auto Orient"
},
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"ddd": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"ef": {
"items": {
"$ref": "#/$defs/effects/effect"
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"title": "Has Masks",
"type": "boolean"
},
"hd": {
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"title": "In Point",
"type": "number"
},
"ks": {
"$ref": "#/$defs/helpers/transform",
"title": "Transform"
},
"masksProperties": {
"items": {
"$ref": "#/$defs/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"op": {
"title": "Out Point",
"type": "number"
},
"parent": {
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/$defs/constants/matte-mode",
"title": "Matte Mode"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op",
"ks"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 6812ae853a892ca2a0ec2475ba6781620ee89c13 | 2022-04-18T10:02:10 | docs/schema/layers/camera-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"ks": {
"$ref": "#/$defs/helpers/transform",
"description": "Layer transform",
"title": "Transform"
},
"pe": {
"$ref": "#/$defs/animated-properties/value",
"description": "Distance from the Z=0 plane.\nSmall values yield a higher perspective effect.",
"title": "Perspective"
}
},
"required": [
"ty",
"au"
],
"type": "object"
}
],
"description": "3D Camera",
"title": "Camera Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape"
},
{
"properties": {
"ind": {
"title": "Index",
"type": "integer"
},
"ks": {
"$ref": "#/$defs/animated-properties/shape-property",
"title": "Shape"
},
"ty": {
"const": "sh",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Animatable Bezier curve",
"title": "Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/animation/metadata.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"title": "Author",
"type": "string"
},
"c": {
"title": "Theme Color",
"type": "string"
},
"d": {
"title": "Description",
"type": "string"
},
"k": {
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array"
}
},
"required": [],
"type": "object"
}
],
"description": "Document metadata",
"title": "Metadata",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ao": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Auto Orient"
},
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"ddd": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"ef": {
"items": {
"$ref": "#/$defs/effects/effect"
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"title": "Has Masks",
"type": "boolean"
},
"hd": {
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"title": "In Point",
"type": "number"
},
"ks": {
"$ref": "#/$defs/helpers/transform",
"title": "Transform"
},
"masksProperties": {
"items": {
"$ref": "#/$defs/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"op": {
"title": "Out Point",
"type": "number"
},
"parent": {
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/$defs/constants/matte-mode",
"title": "Matte Mode"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d4d7b11657e01d91f05f85207c991f040565d18b | 2022-05-20T09:36:32 | docs/schema/styles/inner-glow-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"ch": {
"$ref": "#/$defs/animated-properties/value",
"title": "Choke Spread"
},
"j": {
"$ref": "#/$defs/animated-properties/value",
"title": "Jitter"
},
"no": {
"$ref": "#/$defs/animated-properties/value",
"title": "Noise"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Range"
},
"sr": {
"$ref": "#/$defs/animated-properties/value",
"title": "Source"
},
"ty": {
"const": 4,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"title": "Outer Glow",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/gradient.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/properties/value",
"title": "Highlight Angle"
},
"e": {
"$ref": "#/properties/multi-dimensional",
"title": "End Point"
},
"g": {
"$ref": "#/properties/gradient-colors",
"title": "Colors"
},
"h": {
"$ref": "#/properties/value",
"title": "Highlight Length"
},
"s": {
"$ref": "#/properties/multi-dimensional",
"title": "Start Point"
},
"t": {
"$ref": "#/constants/gradient-type",
"default": 1,
"title": "Gradient Type"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Gradient",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8362bdd4ad1eaef21e98f05d78b011c64ef57fbb | 2021-10-22T09:59:40 | docs/schema/effects/matte3-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "index"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 28,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Matte3Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/shape-element.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/helpers/visual-object"
},
{
"properties": {
"bm": {
"title": "Bm",
"type": "integer"
},
"cix": {
"title": "Property Index",
"type": "integer"
},
"hd": {
"title": "Hidden",
"type": "boolean"
},
"ty": {
"title": "Type",
"type": "string"
}
},
"required": [],
"type": "object"
}
],
"description": "Base class for all elements of ShapeLayer and Group",
"title": "Shape Element",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/gradient-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"$ref": "#/$defs/shapes/gradient"
},
{
"properties": {
"ty": {
"const": "gs",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Gradient stroke",
"title": "Gradient Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/layers/image-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/visual-layer"
},
{
"properties": {
"refId": {
"default": "",
"description": "ID of the image as specified in the assets",
"title": "Image Id",
"type": "string"
},
"ty": {
"const": 2,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"refId"
],
"type": "object"
}
],
"description": "Layer that shows an image asset",
"title": "Image Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 3723525748cf1d1d67fff3603327367a2a22643b | 2021-10-26T11:55:22 | docs/schema/effects/drop-shadow-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effects/effect-value-color",
"title": "color"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"description": "Opacity between 0 and 255",
"title": "opacity"
},
{
"$ref": "#/$defs/effects/effect-value-angle",
"title": "angle"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "distance"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "blur"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 25,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Adds a shadow to the layer\n@note Opacity is in [0, 255]",
"title": "Drop Shadow Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 18a7fe3f9098d8798fe3aef3bbbf7bacbaff4a79 | 2022-02-17T14:19:23 | docs/schema/shapes/base-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"d": {
"items": {
"$ref": "#/$defs/shapes/stroke-dash"
},
"title": "Dashes",
"type": "array"
},
"lc": {
"$ref": "#/$defs/constants/line-cap",
"default": 2,
"title": "Line Cap"
},
"lj": {
"$ref": "#/$defs/constants/line-join",
"default": 2,
"title": "Line Join"
},
"ml": {
"default": 0,
"title": "Miter Limit",
"type": "number"
},
"ml2": {
"$ref": "#/$defs/animated-properties/value",
"description": "Animatable alternative to ml",
"title": "Miter Limit"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"w": {
"$ref": "#/$defs/animated-properties/value",
"title": "Width"
}
},
"required": [
"o",
"w"
],
"type": "object"
}
],
"description": "",
"title": "Base Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/constants/line-cap.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Style at the end of a stoked line",
"oneOf": [
{
"const": 1,
"title": "Butt"
},
{
"const": 2,
"title": "Round"
},
{
"const": 3,
"title": "Square"
}
],
"title": "Line Cap",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 4101dfb699f72d6853764161a7019cc207f7e010 | 2021-10-18T21:20:46 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/helpers/visual-object"
},
{
"$ref": "#/animation/composition"
},
{
"properties": {
"assets": {
"item": {
"$ref": "#/assets/asset"
},
"title": "Assets",
"type": "array"
},
"chars": {
"item": {
"$ref": "#/assets/chars"
},
"title": "Chars",
"type": "array"
},
"ddd": {
"$ref": "#/types/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"fonts": {
"$ref": "#/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"title": "Frame Rate",
"type": "number"
},
"h": {
"default": 512,
"title": "Height",
"type": "integer"
},
"ip": {
"default": 0,
"title": "In Point",
"type": "number"
},
"mn": {
"title": "Match Name",
"type": "string"
},
"op": {
"default": 60,
"title": "Out Point",
"type": "number"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"title": "Width",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op"
],
"type": "object"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/text/font-list.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"list": {
"items": {
"$ref": "#/$defs/text/font"
},
"title": "List",
"type": "array"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Font List",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/matte-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "How a layer should mask another layer",
"oneOf": [
{
"const": 0,
"title": "Normal"
},
{
"const": 1,
"title": "Alpha"
},
{
"const": 2,
"title": "Inverted Alpha"
},
{
"const": 3,
"title": "Luma"
},
{
"const": 4,
"title": "Inverted Luma"
}
],
"title": "MatteMode",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/shapes/gradient-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"$ref": "#/$defs/shapes/gradient"
},
{
"properties": {
"ty": {
"const": "gs",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "shape-stroke-gradient",
"description": "Gradient stroke",
"title": "Gradient Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/shape"
},
{
"properties": {
"ind": {
"title": "Index",
"type": "integer"
},
"ks": {
"$ref": "#/properties/shape-property",
"title": "Shape"
},
"ty": {
"const": "sh",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Animatable Bezier curve",
"title": "Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/layers/image-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"refId": {
"default": "",
"description": "ID of the image as specified in the assets",
"title": "Image Id",
"type": "string"
},
"ty": {
"const": 2,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"refId"
],
"type": "object"
}
],
"description": "",
"title": "Image Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effect-values/effect-value.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ix": {
"title": "Effect Index",
"type": "integer"
},
"mn": {
"title": "Match Name",
"type": "string"
},
"nm": {
"title": "Name",
"type": "string"
},
"ty": {
"title": "Type",
"type": "integer"
}
},
"required": [],
"type": "object"
}
],
"description": "Value for an effect",
"title": "Effect Value",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effect-values/checkbox.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effect-values/effect-value"
},
{
"properties": {
"ty": {
"const": 4,
"title": "Type",
"type": "integer"
},
"v": {
"$ref": "#/$defs/animated-properties/value",
"title": "Value"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Effect Value Checkbox",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/text/text-range-selector.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"caniuse": "animators-range-selectors",
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Max Amount"
},
"b": {
"$ref": "#/$defs/constants/text-based",
"title": "Based On"
},
"e": {
"$ref": "#/$defs/animated-properties/value",
"title": "End"
},
"ne": {
"$ref": "#/$defs/animated-properties/value",
"title": "Min Ease"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Offset"
},
"r": {
"$ref": "#/$defs/constants/text-range-units",
"caniuse": "range-selectors-units",
"title": "Range Units"
},
"rn": {
"$ref": "#/$defs/helpers/int-boolean",
"title": "Randomize"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"title": "Start"
},
"sh": {
"$ref": "#/$defs/constants/text-shape",
"title": "Shape"
},
"sm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Selector Smoothness"
},
"t": {
"$ref": "#/$defs/helpers/int-boolean",
"title": "Expressible"
},
"xe": {
"$ref": "#/$defs/animated-properties/value",
"title": "Max Ease"
}
},
"required": [
"t",
"xe",
"ne",
"a",
"b",
"rn",
"sh"
],
"title": "Text Range Selector",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/repeater-transform.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/transform"
},
{
"properties": {
"eo": {
"$ref": "#/$defs/animated-properties/value",
"title": "End Opacity"
},
"so": {
"$ref": "#/$defs/animated-properties/value",
"title": "Start Opacity"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Repeater Transform",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 7ce92ecbe87c57f0a66ed19fa889b76cbedb9682 | 2022-05-19T14:42:05 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"assets": {
"description": "List of assets that can be referenced by layers",
"items": {
"oneOf": [
{
"$ref": "#/$defs/assets/image"
},
{
"$ref": "#/$defs/assets/precomposition"
},
{
"$ref": "#/$defs/assets/sound"
}
]
},
"title": "Assets",
"type": "array"
},
"chars": {
"description": "Data defining text characters as lottie shapes. If present a player might only render characters defined here and nothing else.",
"items": {
"$ref": "#/$defs/text/character-data"
},
"title": "Chars",
"type": "array"
},
"comps": {
"description": "List of Extra compositions not referenced by anything",
"items": {
"$ref": "#/$defs/assets/precomposition"
},
"title": "Extra Compositions",
"type": "array"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the animation has 3D layers",
"title": "Threedimensional"
},
"fonts": {
"$ref": "#/$defs/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"h": {
"default": 512,
"description": "Height of the animation",
"title": "Height",
"type": "integer"
},
"ip": {
"default": 0,
"description": "\"In Point\", which frame the animation starts at (usually 0)",
"title": "In Point",
"type": "number"
},
"markers": {
"description": "Markers defining named sections of the composition.",
"items": {
"$ref": "#/$defs/helpers/marker"
},
"title": "Markers",
"type": "array"
},
"mb": {
"$ref": "#/$defs/animation/motion-blur",
"title": "Motion Blur"
},
"meta": {
"$ref": "#/$defs/animation/metadata",
"description": "Document metadata",
"title": "Metadata"
},
"metadata": {
"description": "User-defined metadata",
"title": "User Metadata",
"type": "object"
},
"op": {
"default": 60,
"description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
"title": "Out Point",
"type": "number"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"description": "Width of the animation",
"title": "Width",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op",
"ip"
],
"type": "object"
},
{
"$ref": "#/$defs/animation/composition"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/layers/shape-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/layers/layer"
},
{
"properties": {
"shapes": {
"item": {
"$ref": "#/shapes/shape-element"
},
"title": "Shapes",
"type": "array"
},
"ty": {
"const": 4,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Layer containing ShapeElement objects",
"title": "Shape Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 718213e5e7f2fb9f87829f70a6593b4d739e43eb | 2021-10-26T07:06:57 | docs/schema/helpers/transform.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/position",
"description": "Position / Translation",
"title": "Position"
}
}
},
{
"properties": {
"px": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split position X component",
"title": "Position X"
},
"py": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split position Y component",
"title": "Position Y"
},
"pz": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split position Y component",
"title": "Position Z"
}
}
}
],
"description": "Layer transform",
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/position",
"description": "Anchor point: a position (relative to its parent) around which transformations are applied (ie: center for rotation / scale)",
"title": "Anchor Point"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"description": "Rotation in degrees, clockwise",
"title": "Rotation"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"description": "Scale factor, `[100, 100]` for no scaling",
"title": "Scale"
},
"sa": {
"$ref": "#/$defs/animated-properties/value",
"description": "Direction along which skew is applied, in degrees (`0` skews along the X axis, `90` along the Y axis)",
"title": "Skew Axis"
},
"sk": {
"$ref": "#/$defs/animated-properties/value",
"description": "Skew amount as an angle in degrees",
"title": "Skew"
}
},
"title": "Transform",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/base-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"d": {
"item": {
"$ref": "#/shapes/stroke-dash"
},
"title": "Dashes",
"type": "array"
},
"lc": {
"$ref": "#/constants/line-cap",
"default": 2,
"title": "Line Cap"
},
"lj": {
"$ref": "#/constants/line-join",
"default": 2,
"title": "Line Join"
},
"ml": {
"default": 0,
"title": "Miter Limit",
"type": "number"
},
"o": {
"$ref": "#/properties/value",
"title": "Opacity"
},
"w": {
"$ref": "#/properties/value",
"title": "Width"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Base Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | bc9a3f40c7bbf65091fcc23505f5e641bd1e6527 | 2022-07-09T16:10:00 | docs/schema/shapes/path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape"
},
{
"properties": {
"ks": {
"$ref": "#/$defs/animated-properties/shape-property",
"description": "Bezier path",
"title": "Shape"
},
"ty": {
"const": "sh",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"ks"
],
"type": "object"
}
],
"caniuse": "shape-path",
"description": "Animatable Bezier curve",
"title": "Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d4d7b11657e01d91f05f85207c991f040565d18b | 2022-05-20T09:36:32 | docs/schema/styles/drop-shadow-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"description": "Local light angle",
"title": "Angle"
},
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"ch": {
"$ref": "#/$defs/animated-properties/value",
"title": "Choke Spread"
},
"d": {
"$ref": "#/$defs/animated-properties/value",
"title": "Distance"
},
"lc": {
"$ref": "#/$defs/animated-properties/value",
"description": "Layer knowck out drop shadow",
"title": "Layer Conceal"
},
"no": {
"$ref": "#/$defs/animated-properties/value",
"title": "Noise"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"description": "Blur size",
"title": "Size"
},
"ty": {
"const": 1,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"title": "Drop Shadow",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 09f7f2bf9faa628c6728b9bc8bb75d0f79fcce13 | 2021-10-19T15:25:56 | docs/schema/constants/font-path-origin.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 0,
"title": "Local"
},
{
"const": 1,
"title": "Css Url"
},
{
"const": 2,
"title": "Script Url"
},
{
"const": 3,
"title": "Font Url"
}
],
"title": "FontPathOrigin",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 48d8feb1f07379ebfe51f97f9b548566ee4a3193 | 2022-10-13T05:38:12 | docs/schema/text/character-data.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines character shapes",
"properties": {
"ch": {
"default": "",
"title": "Character",
"type": "string"
},
"data": {
"oneOf": [
{
"$ref": "#/$defs/text/character-shapes"
},
{
"$ref": "#/$defs/text/character-precomp"
}
],
"title": "Data"
},
"fFamily": {
"default": "",
"title": "Font Family",
"type": "string"
},
"size": {
"default": 0,
"title": "Font Size",
"type": "number"
},
"style": {
"default": "",
"title": "Font Style",
"type": "string"
},
"w": {
"default": 0,
"title": "Width",
"type": "number"
}
},
"required": [
"data",
"ch",
"fFamily",
"size",
"style",
"w"
],
"title": "Character Data",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | aa5b29ee6d5a596aa4b6123a80a49c5f13cbd81c | 2021-10-18T13:52:26 | docs/schema/constants/mask-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "How masks interact with each other. See https://helpx.adobe.com/after-effects/using/alpha-channels-masks-mattes.html",
"oneOf": [
{
"const": "n",
"title": "No"
},
{
"const": "a",
"title": "Add"
},
{
"const": "s",
"title": "Subtract"
},
{
"const": "i",
"title": "Intersect"
},
{
"const": "l",
"title": "Lightent"
},
{
"const": "d",
"title": "Darken"
},
{
"const": "f",
"title": "Difference"
}
],
"title": "MaskMode",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 6020e43c6f673c71cab5649a7b3f99995503dce3 | 2021-10-27T18:27:57 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"assets": {
"items": {
"oneOf": [
{
"$ref": "#/$defs/assets/image"
},
{
"$ref": "#/$defs/assets/precomposition"
}
]
},
"title": "Assets",
"type": "array"
},
"chars": {
"description": "Data defining text characters as lottie shapes",
"items": {
"$ref": "#/$defs/text/character-data"
},
"title": "Chars",
"type": "array"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"fonts": {
"$ref": "#/$defs/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"h": {
"default": 512,
"description": "Height of the animation",
"title": "Height",
"type": "integer"
},
"ip": {
"default": 0,
"description": "\"In Point\", which frame the animation starts at (usually 0)",
"title": "In Point",
"type": "number"
},
"mb": {
"$ref": "#/$defs/animation/motion-blur",
"title": "Motion Blur"
},
"meta": {
"$ref": "#/$defs/animation/metadata",
"description": "Document metadata",
"title": "Metadata"
},
"op": {
"default": 60,
"description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
"title": "Out Point",
"type": "number"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"description": "Width of the animation",
"title": "Width",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op",
"ip"
],
"type": "object"
},
{
"$ref": "#/$defs/animation/composition"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/shapes/rectangle.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape"
},
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"description": "Center of the rectangle",
"title": "Position"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Rounded"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Size"
},
"ty": {
"const": "rc",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "A simple rectangle shape",
"title": "Rectangle",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effect-values/slider.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effect-values/effect-value"
},
{
"properties": {
"ty": {
"const": 0,
"title": "Type",
"type": "integer"
},
"v": {
"$ref": "#/$defs/animated-properties/value",
"title": "Value"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Effect Value Slider",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/effects/drop-shadow-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ty": {
"const": 25,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Adds a shadow to the layer. Note: Opacity is in [0, 255]",
"title": "Drop Shadow Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effects/fill-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effect-values/point",
"title": "00"
},
{
"$ref": "#/$defs/effect-values/drop-down",
"title": "01"
},
{
"$ref": "#/$defs/effect-values/color",
"title": "color"
},
{
"$ref": "#/$defs/effect-values/drop-down",
"title": "03"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "04"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "05"
},
{
"$ref": "#/$defs/effect-values/slider",
"description": "Opacity in [0, 1]",
"title": "opacity"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 21,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Replaces the whole layer with the given color\n@note Opacity is in [0, 1]",
"title": "Fill Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/effects/drop-shadow-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/effects/effect"
},
{
"properties": {
"ty": {
"const": 25,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Adds a shadow to the layer\n@note Opacity is in [0, 255]",
"title": "Drop Shadow Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/gradient-fill.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/shape-element"
},
{
"$ref": "#/shapes/gradient"
},
{
"properties": {
"o": {
"$ref": "#/properties/value",
"title": "Opacity"
},
"r": {
"$ref": "#/constants/fill-rule",
"title": "Fill Rule"
},
"ty": {
"const": "gf",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Gradient fill",
"title": "Gradient Fill",
"type": "object"
} | CC-BY-4.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.