Param Name | Description |
---|---|
search Optional |
filter results Value: Must be String |
order Optional |
sort results Value: Must be String |
page Optional |
paginate results Value: Must be String |
per_page Optional |
number of entries per request Value: Must be String |
Param Name | Description |
---|---|
id Required |
Numerical ID or realm name Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
The name field is used for the name of the realm.
Param Name | Description |
---|---|
realm Required |
Value: Must be a Hash |
realm[name] Required |
The realm name, e.g. EXAMPLE.COM Value: Must be String |
realm[realm_proxy_id] Required , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Proxy to use for this realm Value: Must be a number. |
realm[realm_type] Required |
Realm type, e.g. FreeIPA or Active Directory Value: Must be String |
Param Name | Description |
---|---|
id Required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
realm Required |
Value: Must be a Hash |
realm[name] Optional |
The realm name, e.g. EXAMPLE.COM Value: Must be String |
realm[realm_proxy_id] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Proxy to use for this realm Value: Must be a number. |
realm[realm_type] Optional |
Realm type, e.g. FreeIPA or Active Directory Value: Must be String |
Param Name | Description |
---|---|
id Required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |