key¶
Authentication key management
key Specification¶
Parameter Value Type Collection Object Key(s) key-chain-flag, key-chain-name Collection Name key-list Collection URI /axapi/v3/key Element Name key Element URI /axapi/v3/key/{key-chain-flag}+{key-chain-name} Element Attributes key_attributes Partition Visibility shared Schema key schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/key | ||
Create List | POST | /axapi/v3/key | ||
Get Object | GET | /axapi/v3/key/{key-chain-flag}+{key-chain-name} | ||
Get List | GET | /axapi/v3/key | ||
Modify Object | POST | /axapi/v3/key/{key-chain-flag}+{key-chain-name} | ||
Replace Object | PUT | /axapi/v3/key/{key-chain-flag}+{key-chain-name} | ||
Replace List | PUT | /axapi/v3/key | ||
Delete Object | DELETE | /axapi/v3/key/{key-chain-flag}+{key-chain-name} |
key-list¶
key-list is JSON List of key attributes
key-list : [
]
key attributes¶
key-chain-flag
Description Key-chain management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
key-chain-name
Description Key-chain name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
key-list
Type: List
Reference Object: /axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
key-list¶
Specification Value Type list Block object keys key-number
Description Key identifier number
Type: number
Range: 1-255
key-string
Description Set key string (The key)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters