API Reference for device/msonline/MsolServicePrincipal

Model ref.: device/msonline/MsolServicePrincipal

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/device/msonline/MsolServicePrincipal/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "StartDate": {
               "__type_requested": "DateTime", 
               "__type_mapping_type": "DateTime", 
               "description": "The effective start date of the credential usage. The default start date value is today.", 
               "title": "StartDate", 
               "format": "date-time", 
               "required": false, 
               "readonly": false, 
               "type": "string", 
               "name": "StartDate"
          }, 
          "AccountEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Specifies if the account needs to be enabled. This will be set to true if not specified.", 
               "title": "AccountEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AccountEnabled"
          }, 
          "EndDate": {
               "__type_requested": "DateTime", 
               "__type_mapping_type": "DateTime", 
               "description": "The effective end date of the credential usage. The default end date value is one year from today.", 
               "title": "EndDate", 
               "format": "date-time", 
               "required": false, 
               "readonly": false, 
               "type": "string", 
               "name": "EndDate"
          }, 
          "Addresses": {
               "__type_requested": "System.Collections.Generic.List[Microsoft.Online.Administration.RedirectUri]", 
               "required": false, 
               "description": "List of addresses used by the application.  The list should be constructed by using the New-MsolServicePrincipalAddress help cmdlet.", 
               "title": "Addresses", 
               "__type_mapping_type": "Unknown", 
               "name": "Addresses", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ObjectId": {
               "__type_requested": "guid", 
               "required": false, 
               "name": "ObjectId", 
               "title": "ObjectId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string", 
               "description": "The object ID associated with the service principal to retrieve."
          }, 
          "TrustedForDelegation": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "TrustedForDelegation", 
               "title": "TrustedForDelegation", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ServicePrincipalNames": {
               "__type_requested": "string[]", 
               "required": false, 
               "description": "A list of service principal names (SPNs) associated with the service principal.\nAn SPN must be unique per company tenant and is used by an application to uniquely identify itself.  By default the service principal AppID is always added as an SPN.  \nAn SPN must use one of the following formats \"appName\" or \"appName/hostname\" or be a valid URL.  AppName represents the name of the application and hostname represents the URI authority for the application.  When the service principal represents a WS-Federation relying party, an SPN can be set to a URL that would be treated as the WS-Federation wtrealm parameter.", 
               "title": "ServicePrincipalNames", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "ServicePrincipalNames"
          }, 
          "Value": {
               "__type_requested": "string", 
               "required": false, 
               "description": "The value of the credential. If the credential type is set to \"asymmetric\", it represents the base 64 encoded certificate. If the credential type is set to \"symmetric\" and Value is not set, a 256 bit AES key will be automatically created and valid for one year from creation. If the credential type is set to \"password\", the Value parameter must be supplied and it should not be base 64 encoded.", 
               "title": "Value", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Value"
          }, 
          "TenantId": {
               "__type_requested": "Guid", 
               "required": false, 
               "description": "The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.", 
               "title": "TenantId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "TenantId"
          }, 
          "ExtensionData": {
               "__type_requested": "System.Runtime.Serialization.ExtensionDataObject", 
               "required": false, 
               "name": "ExtensionData", 
               "title": "ExtensionData", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "AppPrincipalId": {
               "__type_requested": "Guid", 
               "required": false, 
               "description": "The unique application identifier for a service principal in a tenant. Once created this property cannot be changed. If an AppPrincipalId is not specified, one will be generated.", 
               "title": "AppPrincipalId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "AppPrincipalId"
          }, 
          "Usage": {
               "__type_requested": "ServicePrincipalCredentialUsage", 
               "required": false, 
               "description": "The usage of the credential key. The credential key usage can either be set to \"sign\" or \"verify\" a token.  The default setting is \"verify\".  Sign is allowed ONLY for symmetric keys.  Verify is allowed for all key types.\nA \"verify\" credential key is required by Windows Azure Active Directory to verify that the request token was sent by your application (represented by this service principal). Your application may optionally require that Windows Azure Active Directory issue tokens to your application signed with your signing key rather than the asymmetric public key identifying Windows Azure Active Directory. In this case, provide a \"sign\" credential key for your service principal.", 
               "title": "Usage", 
               "__type_mapping_type": "Unknown", 
               "name": "Usage", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "DisplayName": {
               "__type_requested": "string", 
               "required": true, 
               "description": "The friendly name of the service principal", 
               "title": "DisplayName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DisplayName"
          }, 
          "Type": {
               "__type_requested": "ServicePrincipalCredentialType", 
               "required": false, 
               "description": "The type of credential used. The credential type can either be set to \"asymmetric\", \"symmetric\" or \"password\".  If \"asymmetric\", the Value parameter must be set to the public portion of a base 64 encoded X509 certificate.  If \"symmetric\", then a 256 bit AES symmetric key will be generated if Value is not set.  If \"password\", the Value parameter must be supplied and it should not be base 64 encoded.  The default setting is \"symmetric\".", 
               "title": "Type", 
               "__type_mapping_type": "Unknown", 
               "name": "Type", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }
     }, 
     "schema_version": "2017.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/msonline/MsolServicePrincipal/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/msonline/MsolServicePrincipal 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/device/msonline/MsolServicePrincipal	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/device/msonline/MsolServicePrincipal/	hierarchy=[hierarchy]	{"hrefs":["/api/device/msonline/MsolServicePrincipal/[pkid1]", "/api/device/msonline/MsolServicePrincipal/[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: device/msonline/MsolServicePrincipal
```
GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/msonline/MsolServicePrincipal/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/msonline/MsolServicePrincipal device/msonline/MsolServicePrincipal schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/msonline/MsolServicePrincipal/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msonline/MsolServicePrincipal/[pkid1]", "/api/v0/device/msonline/MsolServicePrincipal/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/msonline/MsolServicePrincipal	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/msonline/MsolServicePrincipal/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/msonline/MsolServicePrincipal	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/msonline/MsolServicePrincipal/[pkid1]", "/api/device/msonline/MsolServicePrincipal/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json&schema_rules=true

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

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

 GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/msonline/MsolServicePrincipal/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/msonline/MsolServicePrincipal/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

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

(The list will return 0 to 3 device/msonline/MsolServicePrincipal instances)

GET http://[host]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/msonline/MsolServicePrincipal/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "2017.1", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/msonline/MsolServicePrincipal/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/msonline/MsolServicePrincipal/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/msonline/MsolServicePrincipal", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/msonline/MsolServicePrincipal/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/msonline/MsolServicePrincipal/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/msonline/MsolServicePrincipal/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/msonline/MsolServicePrincipal/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/msonline/MsolServicePrincipal/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/msonline/MsolServicePrincipal/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/msonline/MsolServicePrincipal", 
          "model_specific_actions": [
               "get", 
               "list", 
               "get", 
               "list", 
               "add", 
               "add", 
               "remove", 
               "remove", 
               "update", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "DisplayName", 
                    "title": "DisplayName"
               }, 
               {
                    "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/msonline/MsolServicePrincipal.	GET	/api/device/msonline/MsolServicePrincipal/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/msonline/MsolServicePrincipal 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/device/msonline/MsolServicePrincipal/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/msonline/MsolServicePrincipal/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/msonline/MsolServicePrincipal/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/msonline/MsolServicePrincipal

GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/msonline/MsolServicePrincipal	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/msonline/MsolServicePrincipal; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/msonline/MsolServicePrincipal/[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 device/msonline/MsolServicePrincipal and the JSON format can be used to import instances of device/msonline/MsolServicePrincipal.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/msonline/MsolServicePrincipal/[pkid]	hierarchy=[hierarchy]	The device/msonline/MsolServicePrincipal instance with [pkid].

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

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/msonline/MsolServicePrincipal/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/msonline/MsolServicePrincipal

GET http://[host-proxy]/api/device/msonline/MsolServicePrincipal/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/msonline/MsolServicePrincipal/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge