[Index]
Model ref.: device/cucm/CredentialPolicy
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"minCharsToChange": {
"description": "Minimum Character Change difference between the old and new password.",
"title": "Min Chars To Change",
"minItems": 1,
"required": true,
"default": 1,
"maxItems": 1,
"type": "integer"
},
"resetFailedLogonAttempts": {
"description": "Reset Failed logon attempts must be a number in the range 1 to 120. (minutes)",
"title": "Reset Failed Logon Attempts",
"minItems": 1,
"required": true,
"default": 30,
"maxItems": 1,
"type": "integer"
},
"lockoutDuration": {
"description": "Lockout duration must be a number in the range 0 to 1440. (minutes), If 0 is entered then Administrator Must Unlock is true.",
"title": "Lockout Duration",
"minItems": 1,
"required": true,
"default": 30,
"maxItems": 1,
"type": "integer"
},
"credChangeDuration": {
"description": "Credential change duration must be a number in the range 0 to 129600. (minutes)",
"title": "Cred Change Duration",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"prevCredStoredNum": {
"description": "Stored number of previous credentials must be a number in the range 0 to 25.",
"title": "Prev Cred Stored Num",
"minItems": 1,
"required": true,
"default": 12,
"maxItems": 1,
"type": "integer"
},
"credExpiresAfter": {
"description": "Credential expires after must be a number in the range 0 to 365. (Days). If 0 is entered, then neverExpires is true",
"title": "Cred Expires After",
"minItems": 1,
"required": true,
"default": 180,
"maxItems": 1,
"type": "integer"
},
"trivialCredCheck": {
"title": "Trivial Cred Check",
"minItems": 1,
"required": true,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"expiryWarningDays": {
"description": "Expiry warning days must be a number in the range 0 to 90.",
"title": "Expiry Warning Days",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"failedLogon": {
"description": "Failed logon must be a number in the range 0 to 100. If 0 is entered, NoLimitForFailedLogon is true",
"title": "Failed Logon",
"minItems": 1,
"required": true,
"default": 3,
"maxItems": 1,
"type": "integer"
},
"minCredLength": {
"description": "Minimum credential length must be a number in the range 0 to 64.",
"title": "Min Cred Length",
"minItems": 1,
"required": true,
"default": 8,
"maxItems": 1,
"type": "integer"
},
"inactiveDaysAllowed": {
"description": "Inactive days allowed must be a number in the range 0 to 5000.",
"title": "Inactive Days Allowed",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/CredentialPolicy/add/ |
|
The GUI Add form of device/cucm/CredentialPolicy as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cucm/CredentialPolicy/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/CredentialPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/CredentialPolicy/[pkid1]", "/api/device/cucm/CredentialPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/CredentialPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/CredentialPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/CredentialPolicy/[pkid1]", "/api/v0/device/cucm/CredentialPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/CredentialPolicy |
|
{"hrefs": ["/api/device/cucm/CredentialPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/CredentialPolicy |
|
{"hrefs": ["/api/device/cucm/CredentialPolicy/[pkid1]", "/api/device/cucm/CredentialPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/CredentialPolicy/export/ |
|
{ "hrefs":["/api/device/cucm/CredentialPolicy/[pkid1]", "/api/device/cucm/CredentialPolicy/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cucm/CredentialPolicy and the JSON format can be used to import instances of device/cucm/CredentialPolicy.
GET http://[host-proxy]/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/CredentialPolicy | POST | /api/device/cucm/CredentialPolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cucm/CredentialPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/CredentialPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/CredentialPolicy/ |
|
The device/cucm/CredentialPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/CredentialPolicy instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"add",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/CredentialPolicy/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cucm/CredentialPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/CredentialPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/CredentialPolicy/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cucm/CredentialPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/CredentialPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/CredentialPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/CredentialPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/CredentialPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/CredentialPolicy",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae5e1ce894e001205607f",
"meta": {
"tags": [],
"cached": true,
"title": "Default Credential Policy",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5e1ce894e001205607f",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5e1ce894e001205607f/?model_type=device/cucm/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5e1ce894e001205607f"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "Default Credential Policy",
"minCharsToChange": 1,
"resetFailedLogonAttempts": 30,
"lockoutDuration": 30,
"credExpiresAfter": 0,
"prevCredStoredNum": 0,
"credChangeDuration": 0,
"trivialCredCheck": false,
"expiryWarningDays": 0,
"inactiveDaysAllowed": 0,
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"failedLogon": 5,
"minCredLength": 1,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae5e1ce894e001205607f",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Default Credential Policy",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae5e1ce894e001205607f",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5e1ce894e001205607f/?hierarchy=[hierarchy]&model_type=device/cucm/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/CredentialPolicy/5f3ae5e1ce894e001205607f/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5e1ce894e001205607f"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "Default Credential Policy",
"minCharsToChange": 1,
"resetFailedLogonAttempts": 30,
"lockoutDuration": 30,
"credExpiresAfter": 0,
"prevCredStoredNum": 0,
"credChangeDuration": 0,
"trivialCredCheck": false,
"expiryWarningDays": 0,
"failedLogon": 5,
"minCredLength": 1,
"inactiveDaysAllowed": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/CredentialPolicy. | GET | /api/device/cucm/CredentialPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/CredentialPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/CredentialPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/CredentialPolicy | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cucm/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/CredentialPolicy/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cucm/CredentialPolicy and the JSON format can be used to import instances of device/cucm/CredentialPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/CredentialPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/CredentialPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/CredentialPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/CredentialPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |