Keyrelay doc

This commit is contained in:
Martin Lensment 2015-01-19 18:23:21 +02:00
parent f4c11127c6
commit 6b2a63ed7a

View file

@ -2,42 +2,20 @@
### Keyrelay
| Field name | Required | Field description |
| ----------------- |---------- | ----------------- |
| [ext:keyrelay](#extkeyrelay)| true | |
| ext:clTRID | false | Client transaction id |
### ext:keyrelay
| Field name | Required | Field description |
| ----------------- |----------| ----------------- |
| ext:name | true | Domain name |
| [ext:keyData](#extkeydata) | true | |
| [ext:authInfo](#extauthinfo) | true | |
| [ext:expiry](#extexpiry) | true | |
### ext:keyData
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| secDNS:flags | true | Allowed values: 0, 256, 257 |
| secDNS:protocol | true | Allowed values: 3 |
| secDNS:alg | true | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 |
| secDNS:pubKey | true | Public key |
### ext:authInfo
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| domain:pw | true | Domain password |
### ext:expiry
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| ext:relative | true if ext:absolute is not specified | Relative expiry duration (ISO8601) |
| ext:absolute | true if ext:relative is not specified | Absolute expiry date (ISO8601) |
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<ext:keyrelay>` | 1 | |
| `-<ext:name>` | 1 | Domain name |
| `-<ext:keyData>` | 1 | |
| `--<secDNS:flags>` | 1 | Allowed values: 0, 256, 257 |
| `--<secDNS:protocol>` | 1 | Allowed values: 3 |
| `--<secDNS:alg>` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 |
| `--<secDNS:pubKey>` | 1 | Public key |
| `-<ext:authInfo>` | 1 | |
| `--<domain:pw>` | 1 | Domain password. Attribute: roid="String" |
| `-<ext:expiry>` | 1 | |
| `--<ext:relative>` | 0-1 | Relative expiry duration (ISO8601). Required if ext:absolute is not specified |
| `--<ext:absolute>` | 0-1 | Absolute expiry date (ISO8601). Required if ext:relative is not specified |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-keyrelay-with-valid-user-makes-a-keyrelay-request)