[Index]
Defines rules the govern management of user credentials.
Model ref.: data/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": {
"session_login_limit_per_user": {
"default": 0,
"minimum": 0,
"type": "integer",
"description": "The maximum number of concurrent login sessions permitted for a user. A zero (0) value means that user login sessions should not be restricted.",
"title": "Session Login Limit Per User"
},
"disable_failed_login_user_account": {
"default": false,
"type": "boolean",
"description": "Enabling this field will result in user account being disabled if failed login attempt reaches 'Failed Login Count per User' within 'Reset Failed Login Count per User (minutes)'. This field is disabled by default.",
"title": "Disable Failed Login User Account"
},
"reset_failed_login_count_per_user": {
"default": 5,
"type": "integer",
"description": "The number of minutes before the counter is reset for failed login attempts for a given user. This is typically the interval within which a single failure is permitted, also referred to as the permitted long-term rate of failure.",
"title": "Reset Failed Login Count per User (minutes)"
},
"password_reset_questions": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of question from which password reset questions are drawn.",
"title": "Password Reset Question Pool"
},
"password_expires": {
"description": "The interval at which the password expires, in months.",
"title": "Password Expires (months)",
"default": "6",
"required": true,
"choices": [
{
"value": "never",
"title": "Never Expire"
},
{
"value": "3",
"title": "3"
},
{
"value": "4",
"title": "4"
},
{
"value": "5",
"title": "5"
},
{
"value": "6",
"title": "6"
},
{
"value": "7",
"title": "7"
},
{
"value": "8",
"title": "8"
},
{
"value": "9",
"title": "9"
},
{
"value": "10",
"title": "10"
},
{
"value": "11",
"title": "11"
},
{
"value": "12",
"title": "12"
}
],
"type": "string"
},
"inactive_days_before_disabling_user": {
"description": "The number of days a user can be inactive before disabling the account. With a value of 0 no checks are done.",
"title": "Inactive days before disabling user account",
"default": 0,
"required": false,
"maximum": 100000,
"minimum": 0,
"type": "integer"
},
"failed_login_lock_duration": {
"default": 30,
"minimum": 0,
"type": "integer",
"description": "The number of minutes that a user account must be locked for after the failed password attempts have reached the threshold.",
"title": "Lock Duration (minutes)"
},
"password_reuse_time_limit": {
"description": "Period (number of days) from time of creation for which a password can not be reused. Defaults to 15 days. Only values between 0-365 (inclusive) are allowed. A 0 (zero) value means that password reuse time limit does not apply.",
"title": "Password Reuse Time Limit",
"default": "15",
"maximum": 365,
"minimum": 0,
"type": "integer"
},
"minimum_password_length": {
"default": 8,
"minimum": 8,
"type": "integer",
"description": "Minimum length (number of characters) for password.",
"title": "Minimum Password Length"
},
"reset_failed_login_count_per_source": {
"default": 10,
"type": "integer",
"description": "The number of minutes before the counter is reset for failed login attempts for a given source. This is typically the interval within which a single failure is permitted, also referred to as the permitted long-term rate of failure.",
"title": "Reset Failed Login Count per Source (minutes)"
},
"password_reset_questions_number": {
"type": "integer",
"description": "Determines the number of questions asked during a password reset. The number should be less than or equal to number of entries in Reset Question Pool if custom question are not allowed",
"title": "Number of Questions Asked During Password Reset"
},
"change_password_on_first_login": {
"type": "boolean",
"description": "Indicates that users must be forced to change password on the first login",
"title": "User Must Change Password on First Login"
},
"failed_login_count_per_source": {
"default": 10,
"type": "integer",
"description": "The maximum number of failed login attempts for a given source IP address. This is also referred to as the burst size.",
"title": "Failed Login Count per Source"
},
"disable_failed_login_limiting_per_user": {
"type": "boolean",
"description": "Disable failed login limiting per user.",
"title": "Disable Failed Login Limiting per User"
},
"disable_failed_login_limiting_per_source": {
"type": "boolean",
"description": "Disable failed login limiting per source.",
"title": "Disable Failed Login Limiting per Source"
},
"name": {
"minLength": 1,
"required": true,
"type": "string",
"description": "Credential policy name.",
"title": "Name"
},
"failed_login_count_per_user": {
"default": 20,
"minimum": 0,
"type": "integer",
"description": "The maximum number of failed login attempts for a given user. This is also referred to as the burst size.",
"title": "Failed Login Count per User"
},
"enable_password_complexity_validation": {
"default": false,
"type": "boolean",
"description": "Enable password complexity validation, defaults to False. When set to True, passwords shall be validated against the password complexity rules.",
"title": "Enable Password Complexity Validation"
},
"absolute_session_timeout": {
"description": "Defines the maximum number of minutes a session can be active. A value of 0 disables absolute session timeout.",
"title": "Absolute Session Timeout (minutes)",
"default": 1440,
"maximum": 525600,
"minimum": 0,
"type": "integer"
},
"num_different_password_characters": {
"default": 0,
"minimum": 0,
"type": "integer",
"description": "The minimum number of character changes (inserts, removals, or replacements) required between the old and new passwords.",
"title": "Number of Different Password Characters"
},
"minimum_password_age": {
"description": "The number of days within which a user cannot change their password. A zero (0) value means that password age validation is disabled. The minumum value is 1 day and the maximum is 365 days.",
"title": "Minimum Password Age (days)",
"default": 0,
"required": false,
"maximum": 365,
"minimum": 0,
"type": "integer"
},
"idle_session_timeout": {
"description": "Defines the number of minutes a session will remain active in case there is no activity in the session.",
"title": "Idle Session Timeout (minutes)",
"default": 20,
"required": false,
"maximum": 525600,
"minimum": 1,
"type": "integer"
}
},
"schema_version": "0.2.8"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/CredentialPolicy/add/ |
|
The GUI Add form of data/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/data/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/data/CredentialPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/CredentialPolicy/[pkid1]", "/api/data/CredentialPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/CredentialPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/CredentialPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/CredentialPolicy/[pkid1]", "/api/v0/data/CredentialPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/CredentialPolicy/export/ |
|
{ "hrefs":["/api/data/CredentialPolicy/[pkid1]", "/api/data/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 data/CredentialPolicy and the JSON format can be used to import instances of data/CredentialPolicy.
GET http://[host-proxy]/api/data/CredentialPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/CredentialPolicy | POST | /api/data/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/data/CredentialPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/CredentialPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/CredentialPolicy/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/CredentialPolicy/ |
|
The data/CredentialPolicy schema and all instances as JSON. |
(The list will return 0 to 3 data/CredentialPolicy instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/CredentialPolicy/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 5
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.8",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/CredentialPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/CredentialPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/CredentialPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/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/data/CredentialPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/CredentialPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/CredentialPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/CredentialPolicy/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/CredentialPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/CredentialPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/CredentialPolicy",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5df34f09ce894e0012c60026",
"meta": {
"tags": [
"base",
"core"
],
"cached": true,
"title": "Default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.8",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df34f09ce894e0012c60026",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/help",
"method": "GET",
"title": "Help"
}
}
],
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f09ce894e0012c60026"
],
"model_type": "data/CredentialPolicy",
"system_resource": true,
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"session_login_limit_per_user": 0,
"reset_failed_login_count_per_source": 10,
"idle_session_timeout": 20,
"reset_failed_login_count_per_user": 5,
"password_reset_questions": [
"What is your oldest sibling's middle name?",
"In what city or town did your mother and father meet?",
"What street did you live on in third grade?",
"What is your maternal grandmother's maiden name?"
],
"password_expires": "never",
"enable_password_complexity_validation": false,
"pkid": "5df34f09ce894e0012c60027",
"password_reset_questions_number": 3,
"failed_login_count_per_user": 20,
"password_reuse_time_limit": 15,
"failed_login_count_per_source": 10,
"minimum_password_length": 8,
"failed_login_lock_duration": 30,
"absolute_session_timeout": 1440,
"num_different_password_characters": 0,
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys",
"disable_failed_login_limiting_per_user": true,
"disable_failed_login_limiting_per_source": true,
"name": "Default"
}
},
{
"pkid": "5df362ccce894e0012b37d89",
"meta": {
"tags": [],
"cached": true,
"title": "HcsCredentialPolicy",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.8",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df362ccce894e0012b37d89",
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/"
}
],
"parent": [
{
"pkid": "5df35e48ce894e0012b345a1",
"href": "/api/data/HierarchyNode/5df35e48ce894e0012b345a1"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/CredentialPolicy/5df362ccce894e0012b37d89/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5df362ccce894e0012b37d89"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"reset_failed_login_count_per_source": 10,
"reset_failed_login_count_per_user": 5,
"password_reset_questions": [
"What is your oldest sibling's middle name?",
"In what city or town did your mother or father meet?",
"What street did you live on in third grade?",
"What is your maternal grandmother's maiden name?"
],
"password_expires": "never",
"pkid": "5df362ccce894e0012b37d8a",
"name": "HcsCredentialPolicy",
"password_reset_questions_number": 3,
"failed_login_count_per_user": 20,
"password_reuse_time_limit": 15,
"failed_login_count_per_source": 10,
"minimum_password_length": 8,
"enable_password_complexity_validation": false,
"absolute_session_timeout": 1440,
"failed_login_lock_duration": 30,
"hierarchy_friendly_name": "hcs (Hcs)",
"idle_session_timeout": 20,
"disable_failed_login_limiting_per_user": true,
"disable_failed_login_limiting_per_source": true,
"hierarchy_path": "sys.hcs"
}
},
{
"pkid": "5df34f09ce894e0012c60029",
"meta": {
"tags": [
"base",
"core"
],
"cached": true,
"title": "sysadmin",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.8",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df34f09ce894e0012c60029",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60029/help",
"class": "help",
"title": "Help"
}
}
],
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f09ce894e0012c60029"
],
"model_type": "data/CredentialPolicy",
"system_resource": true,
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"session_login_limit_per_user": 0,
"reset_failed_login_count_per_source": 10,
"reset_failed_login_count_per_user": 5,
"name": "sysadmin",
"password_expires": "never",
"enable_password_complexity_validation": false,
"pkid": "5df34f09ce894e0012c6002a",
"password_reset_questions_number": 0,
"failed_login_count_per_user": 20,
"password_reuse_time_limit": 0,
"failed_login_count_per_source": 10,
"minimum_password_length": 8,
"failed_login_lock_duration": 30,
"absolute_session_timeout": 1440,
"num_different_password_characters": 0,
"hierarchy_friendly_name": "sys (System)",
"idle_session_timeout": 20,
"disable_failed_login_limiting_per_user": true,
"disable_failed_login_limiting_per_source": true,
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "5df34f09ce894e0012c60026",
"meta": {
"tags": [
"base",
"core"
],
"cached": false,
"title": "Default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.2.8",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "5df34f09ce894e0012c60026",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/CredentialPolicy/5df34f09ce894e0012c60026/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f09ce894e0012c60026"
],
"model_type": "data/CredentialPolicy",
"system_resource": true,
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"session_login_limit_per_user": 0,
"reset_failed_login_count_per_source": 10,
"reset_failed_login_count_per_user": 5,
"password_reset_questions": [
"What is your oldest sibling's middle name?",
"In what city or town did your mother and father meet?",
"What street did you live on in third grade?",
"What is your maternal grandmother's maiden name?"
],
"password_expires": "never",
"pkid": "5df34f09ce894e0012c60027",
"name": "Default",
"password_reset_questions_number": 3,
"failed_login_count_per_user": 20,
"password_reuse_time_limit": 15,
"minimum_password_length": 8,
"failed_login_lock_duration": 30,
"absolute_session_timeout": 1440,
"num_different_password_characters": 0,
"disable_failed_login_limiting_per_user": true,
"idle_session_timeout": 20,
"failed_login_count_per_source": 10,
"disable_failed_login_limiting_per_source": true,
"enable_password_complexity_validation": false
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/CredentialPolicy. | GET | /api/data/CredentialPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/CredentialPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/CredentialPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/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 data/CredentialPolicy and the JSON format can be used to import instances of data/CredentialPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/CredentialPolicy/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/CredentialPolicy/[pkid]/ | hierarchy=[hierarchy] | The data/CredentialPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/CredentialPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/CredentialPolicy. |