[Index]
Model ref.: device/skypeforbusiness/CsPinPolicy
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": { "MaximumLogonAttempts": { "__type_requested": "UInt32", "required": false, "description": "Indicates the number of sequential logon failures that are allowed before a user's PIN is automatically locked. Logon failures are counted in two different ways: local logon failures and global logon failures. When a user first tries to logon, a new 30 minute observation window starts; each failed logon during that 30 minute window is recorded as both a local logon failure and a global logon failure. If the user reaches the MaximumLogonAttempts during that 30 minute observation window then he or she will temporarily be locked out of the system for one hour; during this time they will not be able to logon using PIN authentication even if they supply the correct PIN.\nAfter the lockout period has expired, the user's local logon attempts will be reset to 0. However, the user's global logon attempts will not be reset. If the user continually fails to logon, he or she will eventually reach the maximum number of allowed global logon attempts. Any user who reaches that point will have their PIN locked by the system, and will not be able to use PIN authentication until an administrator has unlocked the PIN.\nThe maximum number of allowed logon attempts also varies with PIN size; this is why the MaximumLogonAttempts property does not show a default value when you run Get-CsPinPolicy. By default, a PIN length of 4 allows users 10 local logon attempts and 100 global logon attempts. A PIN length of 5 allows 25 local and 1000 global logon attempts, and PIN lengths greater than 6 allow 25 local tries and 5000 global tries. If you specify a value for the MaximumLogonAttempts property that value will be used for the maximum allowed number of local logon tries; however, global logon values do not change regardless of the value assigned to MaximumLogonAttempts.\nEach time a user successfully logs on using PIN authentication the local failed logon attempts is reset to 0. The global logon attempts are only reset when an administrator unlocks a user's PIN.\nMaximumLogonAttempts can be set to any whole number between 1 and 999, inclusive. However, it is recommended that you do not modify this property. When set to a null value (the default value) Skype for Business Server 2015 will automatically calculate lockout policies. This typically provides the most security.", "title": "MaximumLogonAttempts", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaximumLogonAttempts" }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide explanatory text to accompany a PIN policy. For example, the Description might include information about the users the policy should be assigned to.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "PINHistoryCount": { "__type_requested": "uint64", "required": false, "description": "Indicates how often users are allowed to reuse the same PIN. For example, if the PINHistoryCount is set to 3, then the first three times a user resets his or her PIN they must use a new PIN; on the fourth reset, they can reuse their first PIN. (And, on the fifth reset, they can reuse their second PIN, and so on.) The PIN history count can be any whole number between 0 and 20, inclusive; 0 means that users can use the same PIN number over and over again. By default, PINHistoryCount is set to 0.\nIf the PINLifetime is set to any value greater than 0 then the PINHistoryCount must also be greater than 0. For example, you cannot set PINLifetime to 30 and leave PINHistoryCount at 0.", "title": "PINHistoryCount", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "PINHistoryCount" }, "AllowCommonPatterns": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not \"common patterns\" are allowed in PINs. Common patterns include repeating digits (222222); four or more consecutive digits (123456); and PINs that match a user's phone number or extension number. If set to True common patterns (such as the PIN 456789, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. The default value is False.", "title": "AllowCommonPatterns", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowCommonPatterns" }, "PINLifetime": { "__type_requested": "uint64", "required": false, "description": "Indicates the length of time (in days) that a PIN remains valid; after the PIN lifetime expires users must select a new PIN number before they will be allowed to use PIN authentication to gain access to the system. PINLifetime can be set to any whole number between 0 and 999, inclusive; 0 indicates that PIN numbers never expire. By default, the PIN lifetime is set to 0 days.\nIf you set the PINLifetime to a value greater than 0 then you must also set the PINHistoryCount to a value greater than 0.", "title": "PINLifetime", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "PINLifetime" }, "ScopeClass": { "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", "required": false, "name": "ScopeClass", "title": "ScopeClass", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new PIN policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your Skype for Business Online tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", "title": "Tenant", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Tenant" }, "Identity": { "__type_requested": "string", "required": true, "description": "Indicates the unique Identity to be assigned to the policy. PIN policies can be created at the site or per-user scope. To create a policy at the site scope, use syntax similar to this:\n-Identity site:Redmond\nTo create a policy at the per-user scope, use syntax similar to this:\n-Identity RedmondPinPolicy", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "Anchor": { "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", "required": false, "name": "Anchor", "title": "Anchor", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MinPasswordLength": { "__type_requested": "UInt32", "required": false, "description": "The minimum allowed length (that is, the minimum number of digits) in a PIN. For example, if MinPasswordLength is set to 8 then a PIN of 1259 will be rejected because that PIN only has 4 digits. PIN lengths must have at least 4 digits but no more than 24 digits; the default value is 5.", "title": "MinPasswordLength", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MinPasswordLength" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsPinPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsPinPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsPinPolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsPinPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsPinPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsPinPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPinPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsPinPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPinPolicy/[pkid1]", "/api/device/skypeforbusiness/CsPinPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsPinPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsPinPolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsPinPolicy/[pkid1]", "/api/device/skypeforbusiness/CsPinPolicy/[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/skypeforbusiness/CsPinPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPinPolicy.
GET http://[host-proxy]/api/device/skypeforbusiness/CsPinPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsPinPolicy | POST | /api/device/skypeforbusiness/CsPinPolicy/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/skypeforbusiness/CsPinPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsPinPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsPinPolicy/ |
|
The device/skypeforbusiness/CsPinPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsPinPolicy instances)
{ "operations": [ "cs_pin_policy", "move" ], "pagination": { "direction": "asc", "order_by": "Identity", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsPinPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1150", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsPinPolicy/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/skypeforbusiness/CsPinPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsPinPolicy/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/skypeforbusiness/CsPinPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsPinPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsPinPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsPinPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsPinPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "cs_pin_policy": { "support_async": true, "class": "custom", "href": "/api/device/skypeforbusiness/CsPinPolicy/+cs_pin_policy/?hierarchy=[hierarchy]", "method": "POST", "title": "Cs Pin Policy" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsPinPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsPinPolicy", "model_specific_actions": [ "list", "get", "cs_pin_policy", "powershell_disable", "powershell_enable", "powershell_move", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Identity", "title": "Identity" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsPinPolicy. | GET | /api/device/skypeforbusiness/CsPinPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsPinPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsPinPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsPinPolicy | 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/skypeforbusiness/CsPinPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsPinPolicy/[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/skypeforbusiness/CsPinPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPinPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsPinPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsPinPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsPinPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |