API Reference for relation/HcsSsoIdpREL

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/HcsSsoIdpREL/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "login_uri": {
               "pattern": "^\\w+(/\\w+)*$", 
               "required": false, 
               "type": "string", 
               "description": "This is a URI that will be embedded in the base SSO login URL in order to authenticate specifically with this IDP. This field  must only contain alphanumeric characters and forward slashes, and should match the following regular expression ^\\w+(/\\w+)*$ Eg. Given a login URI of provider1/customer1, end users wishing to authenticate against this IDP will login via the following URL: http://hostname/sso/provider1/customer1/login/.", 
               "title": "Login URI"
          }, 
          "entity_id": {
               "required": true, 
               "type": "string", 
               "description": "The unique identifier of the Identity Provider.", 
               "title": "Entity Id"
          }, 
          "sp_fqdn": {
               "title": "Service Provider Domain Name", 
               "required": false, 
               "type": "string", 
               "description": "This is a FQDN that will be embedded in the SP metadata for this IDP for URLs that refer back to the Service Provider (eg ACS). It should match the customer-specific FQDN used for the VOSS-4-UC server.", 
               "format": "host-name"
          }, 
          "authentication": {
               "properties": {
                    "scope": {
                         "default": "Down", 
                         "choices": [
                              {
                                   "value": "Local", 
                                   "title": "Current hierarchy level only"
                              }, 
                              {
                                   "value": "Down", 
                                   "title": "Current hierarchy level and below"
                              }
                         ], 
                         "type": "string", 
                         "description": "Hierarchical scope this server applies to", 
                         "title": "Authentication Scope"
                    }, 
                    "user_type": {
                         "default": "All", 
                         "choices": [
                              {
                                   "value": "Synced_only", 
                                   "title": "LDAP synced users only"
                              }, 
                              {
                                   "value": "All", 
                                   "title": "All users"
                              }
                         ], 
                         "type": "string", 
                         "description": "Type of users that can authenticate against this server.", 
                         "title": "User Sync Type"
                    }
               }, 
               "type": "object", 
               "description": "Authentication settings.", 
               "title": "Authentication settings"
          }, 
          "user_lookup_field": {
               "default": "username", 
               "type": "string", 
               "description": "User field used to bind SSO user with VOSS user.", 
               "title": "User lookup field"
          }, 
          "loginUrl": {
               "type": "object", 
               "properties": {
                    "bap_login_url": {
                         "is_password": false, 
                         "description": "The BAP URL will be updated after you add SSO IDP .", 
                         "title": "Business Admin SSO Login URL", 
                         "required": false, 
                         "displayable": false, 
                         "readonly": false, 
                         "maxLength": 1024, 
                         "type": "string"
                    }, 
                    "note": {
                         "is_password": false, 
                         "description": "Reminder for Uploading IDP Metadata file first.", 
                         "title": "Note", 
                         "required": false, 
                         "displayable": true, 
                         "readonly": false, 
                         "maxLength": 1024, 
                         "type": "string"
                    }, 
                    "entity_id": {
                         "is_password": false, 
                         "description": "The SSO IDP Entity ID", 
                         "title": "IDP Entity ID", 
                         "required": false, 
                         "displayable": false, 
                         "readonly": false, 
                         "maxLength": 1024, 
                         "type": "string"
                    }, 
                    "login_url": {
                         "is_password": false, 
                         "description": "The URL will be updated after you add SSO IDP .", 
                         "title": "SSO Login URL", 
                         "required": false, 
                         "displayable": false, 
                         "readonly": false, 
                         "maxLength": 1024, 
                         "type": "string"
                    }, 
                    "admin_login_url": {
                         "is_password": false, 
                         "description": "The Admin URL will be updated after you add SSO IDP .", 
                         "title": "Admin SSO Login URL", 
                         "required": false, 
                         "displayable": false, 
                         "readonly": false, 
                         "maxLength": 1024, 
                         "type": "string"
                    }
               }, 
               "title": "Login Url"
          }, 
          "metadata": {
               "description": "Indicates where metadata can be found. This can be either a file accessible locally on the system or somewhere on the network.", 
               "title": "Metadata", 
               "required": false, 
               "readonly": false, 
               "type": "object", 
               "properties": {
                    "remote": {
                         "readonly": false, 
                         "required": false, 
                         "type": "object", 
                         "properties": {
                              "url": {
                                   "readonly": false, 
                                   "required": false, 
                                   "type": "string", 
                                   "description": "Location where metadata is to be downloaded from.", 
                                   "title": "URL"
                              }, 
                              "certificate": {
                                   "description": "To verify the authenticity of the file downloaded from the net the local copy of the public key should be used. This public key must be acquired by some out-of-band method.", 
                                   "format": "uri", 
                                   "title": "Certificate", 
                                   "required": false, 
                                   "choices": [], 
                                   "readonly": false, 
                                   "target_model_type": "data/File", 
                                   "type": "string", 
                                   "target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
                              }
                         }, 
                         "title": "Remote Metadata URL"
                    }, 
                    "local": {
                         "target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
                         "title": "Local Metadata File", 
                         "format": "uri", 
                         "required": false, 
                         "choices": [], 
                         "readonly": false, 
                         "target_model_type": "data/File", 
                         "type": "string"
                    }
               }
          }
     }, 
     "schema_version": "2.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/HcsSsoIdpREL/add/	hierarchy=[hierarchy] format=json	The GUI Add form of relation/HcsSsoIdpREL 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/relation/HcsSsoIdpREL	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/relation/HcsSsoIdpREL/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/HcsSsoIdpREL/[pkid1]", "/api/relation/HcsSsoIdpREL/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/HcsSsoIdpREL
```
GET http://[host-proxy]/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsSsoIdpREL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/HcsSsoIdpREL/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/HcsSsoIdpREL/[pkid1]", "/api/relation/HcsSsoIdpREL/[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 relation/HcsSsoIdpREL and the JSON format can be used to import instances of relation/HcsSsoIdpREL.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/HcsSsoIdpREL:

 GET http://[host-proxy]/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for relation/HcsSsoIdpREL	POST	/api/relation/HcsSsoIdpREL/export_bulkload_template/	hierarchy=[hierarchy] modeltype=relation/HcsSsoIdpREL	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/relation/HcsSsoIdpREL/	hierarchy=[hierarchy] format=json schema=true	The relation/HcsSsoIdpREL schema and all instances as JSON.

(The list will return 0 to 3 relation/HcsSsoIdpREL instances)

GET http://[host]/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "field_display_policy", 
          "configuration_template", 
          "help", 
          "get", 
          "export_bulkload_template", 
          "list", 
          "update", 
          "remove", 
          "add", 
          "bulk_update", 
          "export"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "entity_id", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/relation/HcsSsoIdpREL/?skip=0&limit=3&order_by=entity_id&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "2.1", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "self": [
                    {
                         "pkid": null, 
                         "href": "/api/relation/HcsSsoIdpREL/None/"
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/relation/HcsSsoIdpREL/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/relation/HcsSsoIdpREL/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/relation/HcsSsoIdpREL/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/relation/HcsSsoIdpREL/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "relation/HcsSsoIdpREL", 
          "model_specific_actions": [
               "help", 
               "get", 
               "export_bulkload_template", 
               "list", 
               "update", 
               "remove", 
               "add", 
               "export"
          ], 
          "summary_attrs": [
               {
                    "name": "entity_id", 
                    "title": "Entity Id"
               }, 
               {
                    "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 relation/HcsSsoIdpREL.	GET	/api/relation/HcsSsoIdpREL/help	hierarchy=[hierarchy]	On-line help of Model ref.: relation/HcsSsoIdpREL as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/relation/HcsSsoIdpREL/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/relation/HcsSsoIdpREL/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsSsoIdpREL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/HcsSsoIdpREL/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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 relation/HcsSsoIdpREL and the JSON format can be used to import instances of relation/HcsSsoIdpREL.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/relation/HcsSsoIdpREL/[pkid]	hierarchy=[hierarchy]	The relation/HcsSsoIdpREL instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/relation/HcsSsoIdpREL/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for relation/HcsSsoIdpREL.

API Reference for relation/HcsSsoIdpREL

GET http://[host-proxy]/api/relation/HcsSsoIdpREL/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Export

Export Bulk Load Template

List

GET http://[host]/api/relation/HcsSsoIdpREL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Export

Get

Help