{ "opencollection": "1.0.0", "info": { "name": "Microsoft Graph Admin Admin.admin servicePrincipals.servicePrincipal.Actions API", "version": "1.0.0" }, "items": [ { "info": { "name": "servicePrincipals.servicePrincipal.Actions", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Graph Invoke action addKey", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/addKey", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. ServicePrincipals that don't have any existing valid certificates (i.e.: no certificates have been added yet, or all certificates have expired), won't be able to use this service action. Update servicePrincip" }, { "info": { "name": "Microsoft Graph Invoke action addPassword", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/addPassword", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a strong password or secret to a servicePrincipal object." }, { "info": { "name": "Microsoft Graph Invoke action addTokenSigningCertificate", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/addTokenSigningCertificate", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate. The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: \r\n+ The keyCredentials object with the following objects:\r\n + A private key object with usage set to Sign.\r\n + A public key object with usage set to Verify.\r\n+ The passwordCredentials object. All the objects have the same value of customK" }, { "info": { "name": "Microsoft Graph Invoke action checkMemberGroups", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/checkMemberGroups", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups" }, { "info": { "name": "Microsoft Graph Invoke action checkMemberObjects", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/checkMemberObjects", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Microsoft Graph Invoke action checkMemberObjects" }, { "info": { "name": "Microsoft Graph Invoke action getMemberGroups", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/getMemberGroups", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead." }, { "info": { "name": "Microsoft Graph Invoke action getMemberObjects", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/getMemberObjects", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles." }, { "info": { "name": "Microsoft Graph Invoke action removeKey", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/removeKey", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a key credential from a servicePrincipal. This method along with addKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed." }, { "info": { "name": "Microsoft Graph Invoke action removePassword", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/removePassword", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a password from a servicePrincipal object." }, { "info": { "name": "Microsoft Graph Invoke action restore", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/:servicePrincipal-id/restore", "params": [ { "name": "servicePrincipal-id", "value": "", "type": "path", "description": "The unique identifier of servicePrincipal" } ] }, "docs": "Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associa" }, { "info": { "name": "Microsoft Graph Invoke action getAvailableExtensionProperties", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/getAvailableExtensionProperties", "body": { "type": "json", "data": "{}" } }, "docs": "Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:" }, { "info": { "name": "Microsoft Graph Invoke action getByIds", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/getByIds", "body": { "type": "json", "data": "{}" } }, "docs": "Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:" }, { "info": { "name": "Microsoft Graph Invoke action validateProperties", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/servicePrincipals/validateProperties", "body": { "type": "json", "data": "{}" } }, "docs": "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom ban" } ] } ], "bundled": true }