Format XML Tags

When using the AdminApi.adminGetmethod, you use XML tags in the Format field to specify the data that should be retrieved by the method.

The Format XML tags that you specify (and their arrangement) determine both which items of information are retrieved by the method and the manner in which the retrieved information is arranged.

For each child tag (described in the table below), specific Scope tags can be used to set the scope for the information to be retrieved. For certain child tags, the scope is not relevant and Scope tags should not be used.

Format XML tags are also used by the method to label the retrieved information.

The available Format XML tags and relevant Scope tags are described in the table that follows.

Parent Tag	Child Tag	Relevant Scope Tags	Description
none - root	`<context>`	Not relevant	Retrieve the Admin API session context. (No additional child tags are available for the context.)
none - root	`<admin>`		Root element for the format of the XML for information to be retrieved. (The retrieved information is arranged under the `<admin_response>` parent tag.)
`<admin>`	`<hasp>`	`<hasp>`, `<vendor>`	Information regarding a protection key. For more information, see Format XML Tags for Protection Keys
`<admin>`	`<hasp>`	`<c2v_file>`	C2V file containing information regarding the local Sentinel License Manager. For more information, see Generating C2V Files and Fingerprint Files.
`<admin>`	`<certificates>`	`<hasp>`, `<vendor>`	Information regarding a certificate license
`<admin>`	`<detached>`	`<hasp>`, `<vendor>`, `<product>`	Information regarding a detached Product
`<admin>`	`<feature>`	`<hasp>`, `<vendor>`, `<product>`	Information regarding a Feature
`<admin>`	`<product>`	`<hasp>`, `<vendor>`	Information regarding a Product
`<admin>`	`<session>`	All scope tags	Information regarding current sessions for a specific protection key
`<admin>`	`<license_manager>`	Not relevant	Information regarding the local Sentinel License Manager
`<admin>`	`<license_manager>`	`<fingerprint_file>`	Fingerprint of the machine. For more information, see Generating C2V Files and Fingerprint Files.
`<admin>`	`<config>`	Not relevant	Information regarding configuration settings for the local Sentinel License Manager
`<admin>`	`<identity>`	`<identity>`	Information regarding client identities. For more information, see Retrieve a Single Client Identity
`<admin>`	`<identities>`	`<identity>, <filter>`	Information regarding lists of client identities. For more information, see Read a Client Identity List
`<admin>`	`<cloud_licensing> - <create>`	Not relevant	Information for creating client identities. For more information, see Create a Client Identity
`<admin>`	`<cloud_licensing> - <update>`	Not relevant	Information for modifying or disabling client identities.. For more information, see Update a Client Identity
`<admin>`	`<cloud_licensing> - <delete>`	Not relevant	Information for deleting client identities. For more information, see Delete a Client Identity
`<admin>`	`<cloud_licensing> - <unregister>`	Not relevant	Information for unregistering machines. For more information, see Unregister a Machine

For each of the child tags under the <admin> tag, additional tags are used to identify specific elements of information. To retrieve all the available information for a child tag and to see all the available tags, use the following format:

<?xml version="1.0" encoding="UTF-8"?>
<admin>
  <childTag>
    <element name="*"/>
  </childTag>
</admin>

For example:

<?xml version="1.0" encoding="UTF-8"?>
<admin>
  <hasp>
    <element name="*"/>
  </hasp>
</admin>

Format XML Tags

Related Topics