[Index]
Model ref.: relation/HcsSsoSpREL
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": {
"entity_id": {
"description": "Usually your subdomain plus the url to the metadata",
"title": "Entity Id",
"required": false,
"readonly": false,
"type": "string"
},
"sp": {
"description": "Defines the settings that apply to the system when used as a Service Provider",
"title": "Service Provider Settings",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"name": {
"description": "A friendly identifier for the Service Provider",
"title": "Name",
"required": true,
"readonly": false,
"type": "string"
},
"authn_requests_signed": {
"description": "Determines whether outgoing authentication messages will be signed. If so, the specified private key will be used. This attribute is false by default. If one of your identity providers has WantAuthnRequestsSigned set in its meta data, this attribute should be set to true.",
"title": "Sign Authn Requests",
"required": false,
"readonly": false,
"type": "boolean"
},
"request_signature_method": {
"description": "Set the SignatureMethod of the authentication request. Only used when 'Sign Authn Requests' is enabled. Defaults to rsa-sha1.",
"title": "SignatureMethod",
"default": "rsa-sha1",
"required": false,
"choices": [
{
"value": "rsa-sha1",
"title": "rsa-sha1"
},
{
"value": "rsa-sha224",
"title": "rsa-sha224"
},
{
"value": "rsa-sha256",
"title": "rsa-sha256"
},
{
"value": "rsa-sha384",
"title": "rsa-sha384"
},
{
"value": "rsa-sha512",
"title": "rsa-sha512"
}
],
"readonly": false,
"type": "string"
},
"request_digest_method": {
"description": "Set the DigestMethod of the authentication request. Only used when 'Sign Authn Requests' is enabled. Defaults to sha1.",
"title": "DigestMethod",
"default": "sha1",
"required": false,
"choices": [
{
"value": "sha1",
"title": "sha1"
},
{
"value": "sha224",
"title": "sha224"
},
{
"value": "sha256",
"title": "sha256"
},
{
"value": "sha384",
"title": "sha384"
},
{
"value": "sha512",
"title": "sha512"
}
],
"readonly": false,
"type": "string"
},
"want_assertions_signed": {
"description": "Determines whether assertions should be signed. Don't set this attribute to false unless you are sure that checking the integrity of the assertions is not needed in your environment.",
"title": "Want Assertions Signed",
"required": false,
"readonly": false,
"type": "boolean"
},
"want_response_signed": {
"description": "Determines whether responses should be signed. Don't set this to true unless you are sure that all Identity Providers do sign responses.",
"title": "Want Reponse Signed",
"required": false,
"readonly": false,
"type": "boolean"
},
"endpoints": {
"description": "Specifies the various end points that provide an external interface to the service provider.",
"title": "End Points",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"assertion_consumer_service": {
"title": "Assertion Consumer Service",
"items": {
"type": "object",
"properties": {
"binding": {
"description": "Determines how SAML requests and responses map onto standard messaging or communications protocols.",
"title": "Binding",
"required": true,
"choices": [
{
"value": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
"title": "HTTP-POST"
}
],
"readonly": false,
"type": "string"
},
"url": {
"readonly": false,
"required": true,
"type": "string",
"title": "URL"
}
}
},
"required": false,
"readonly": false,
"type": "array"
},
"single_logout_service": {
"title": "Single Logout Service",
"items": {
"type": "object",
"properties": {
"binding": {
"description": "Determines how SAML requests and responses map onto standard messaging or communications protocols.",
"title": "Binding",
"required": true,
"choices": [
{
"value": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect",
"title": "HTTP-REDIRECT"
}
],
"readonly": false,
"type": "string"
},
"url": {
"readonly": false,
"required": true,
"type": "string",
"title": "URL"
}
}
},
"required": false,
"readonly": false,
"type": "array"
}
}
},
"required_attributes": {
"description": "Additional attributes required to identify a user",
"title": "Required Attributes",
"items": {
"type": "string"
},
"required": false,
"readonly": false,
"type": "array"
}
}
},
"use_custom_cert_for_signing": {
"description": "Indicates if previously uploaded public/private keys must be used for signing. If true, the 'Public Key' and 'Private Key' fields are required. If false, a system-generated Public/Private key pair is used.",
"title": "Use Custom Certificate for Signing",
"required": false,
"readonly": false,
"type": "boolean"
},
"system_cert": {
"target": "/api/data/Certificate/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "A reference to the data/Certificate instance that contains the system generated certificate to be used.",
"required": false,
"readonly": false,
"title": "System Generated Certificate",
"type": "string",
"target_model_type": "data/Certificate",
"choices": []
},
"key_file": {
"target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The private key that is used for signing AuthnRequests",
"required": false,
"readonly": false,
"title": "Private Key",
"type": "string",
"target_model_type": "data/File",
"choices": []
},
"cert_file": {
"target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The public key that should be used for decrypting signed AuthnRequests",
"required": false,
"readonly": false,
"title": "Public Key",
"type": "string",
"target_model_type": "data/File",
"choices": []
},
"valid_for": {
"description": "The number of hours for which the metadata is valid for",
"title": "Validity (Hours)",
"required": false,
"readonly": false,
"type": "integer"
},
"accepted_time_diff": {
"description": "The maximum acceptable difference in clock times (in seconds) between this system and any IDP.",
"title": "Accepted Time Difference (seconds)",
"default": 0,
"required": false,
"readonly": false,
"type": "integer"
},
"contact_person": {
"description": "Service Provider contact details",
"title": "Contact Person",
"items": {
"type": "object",
"properties": {
"givenname": {
"description": "Contact's first name",
"title": "First Name",
"required": false,
"readonly": false,
"type": "string"
},
"surname": {
"description": "Contact's last name",
"title": "Last Name",
"required": false,
"readonly": false,
"type": "string"
},
"company": {
"description": "Contact's company",
"title": "Company",
"required": false,
"readonly": false,
"type": "string"
},
"email_address": {
"description": "Contact's email address",
"title": "Email Address",
"required": false,
"readonly": false,
"type": "string"
},
"contact_type": {
"description": "Type of contact",
"title": "Contact Type",
"required": false,
"readonly": false,
"type": "string"
}
}
},
"required": false,
"readonly": false,
"type": "array"
},
"block_unencrypted_assertions": {
"description": "Block unencrypted assertions",
"title": "Block unencrypted assertions",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"spMd": {
"title": "Sp Md",
"type": "object",
"properties": {
"note": {
"title": "Note",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": true
},
"md_url": {
"title": "Metadata URL",
"description": "The URL to SSO SP metadata",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
}
}
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsSsoSpREL/add/ |
|
The GUI Add form of relation/HcsSsoSpREL 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/HcsSsoSpREL | 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/relation/HcsSsoSpREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsSsoSpREL/[pkid1]", "/api/relation/HcsSsoSpREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsSsoSpREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsSsoSpREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsSsoSpREL/export/ |
|
{ "hrefs":["/api/relation/HcsSsoSpREL/[pkid1]", "/api/relation/HcsSsoSpREL/[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/HcsSsoSpREL and the JSON format can be used to import instances of relation/HcsSsoSpREL.
GET http://[host-proxy]/api/relation/HcsSsoSpREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsSsoSpREL | POST | /api/relation/HcsSsoSpREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsSsoSpREL/ |
|
The relation/HcsSsoSpREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsSsoSpREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "entity_id",
"direction": "asc",
"current": "/api/relation/HcsSsoSpREL/?skip=0&limit=3&order_by=entity_id&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsSsoSpREL",
"summary_attrs": [
{
"name": "entity_id",
"title": "Entity Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsSsoSpREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsSsoSpREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSsoSpREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsSsoSpREL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HcsSsoSpREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsSsoSpREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSsoSpREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"entity_id": "https://[host]/sso/metadata",
"sp": {
"name": "[host]",
"request_signature_method": "rsa-sha1",
"request_digest_method": "sha1",
"endpoints": {
"assertion_consumer_service": [
{
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
"url": "https://[host]/sso/acs/"
}
]
},
"required_attributes": [
"uid"
]
},
"system_cert": "[\"SSO-Cert\", \"hcs\"]",
"valid_for": 36,
"accepted_time_diff": 0,
"block_unencrypted_assertions": false,
"pkid": "66e7f75a602b51c0dc2488a4",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "relation/HcsSsoSpREL",
"summary_attrs": [
{
"name": "entity_id",
"title": "Entity Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "https://[host]/sso/metadata",
"business_key": {
"hierarchy": false,
"unique": [
"entity_id"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [
{
"pkid": "66e7f6cb602b51c0dc248894",
"path": "system_cert",
"model_type": "data/Certificate"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/",
"pkid": "66e7f75a602b51c0dc2488a3"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"66e7f75a602b51c0dc2488a3"
],
"schema_version": "0.2.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "66e7f75a602b51c0dc2488a3"
}
]
}
(Show the first instance)
{
"data": {
"entity_id": "https://[host]/sso/metadata",
"sp": {
"name": "[host]",
"request_signature_method": "rsa-sha1",
"request_digest_method": "sha1",
"endpoints": {
"assertion_consumer_service": [
{
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
"url": "https://[host]/sso/acs/"
}
]
},
"required_attributes": [
"uid"
]
},
"system_cert": "[\"SSO-Cert\", \"hcs\"]",
"valid_for": 36,
"accepted_time_diff": 0,
"block_unencrypted_assertions": false,
"spMd": {
"note": "Please go to this link to download SP metadata file",
"md_url": "https://[host]/sso/metadata"
}
},
"meta": {
"model_type": "relation/HcsSsoSpREL",
"summary_attrs": [
{
"name": "entity_id",
"title": "Entity Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "https://[host]/sso/metadata",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"self": [
{
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/",
"pkid": "66e7f75a602b51c0dc2488a3"
}
]
},
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsSsoSpREL/66e7f75a602b51c0dc2488a3/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "66e7f75a602b51c0dc2488a3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsSsoSpREL. | GET | /api/relation/HcsSsoSpREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsSsoSpREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsSsoSpREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsSsoSpREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsSsoSpREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsSsoSpREL/[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 relation/HcsSsoSpREL and the JSON format can be used to import instances of relation/HcsSsoSpREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsSsoSpREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsSsoSpREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsSsoSpREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsSsoSpREL. |