Skip to content

serviceprincipal-getpasswordsinglesignoncredentials.md

Latest commit

 

History

History
149 lines (111 loc) · 5.36 KB

serviceprincipal-getpasswordsinglesignoncredentials.md

File metadata and controls

149 lines (111 loc) · 5.36 KB
title servicePrincipal: getPasswordSingleSignOnCredentials
description Get a list of single sign-on credentials using a password for a user or group.
ms.localizationpriority medium
author Jackson-Woods
ms.subservice entra-applications
doc_type apiPageType
ms.date 10/15/2024

servicePrincipal: getPasswordSingleSignOnCredentials

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of single sign-on credentials using a password for a user or group.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-passwordsinglesignoncredentials-apis]

HTTP request

You can address the service principal using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.

POST /servicePrincipals/{id}/getPasswordSingleSignOnCredentials
POST /servicePrincipals(appId='{appId}')/getPasswordSingleSignOnCredentials

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
id String The ID of the user or group this credential set belongs to.

Response

If successful, this method returns a 200 OK response code and a new passwordSingleSignOnCredentialSet object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/servicePrincipals/{id}/getPasswordSingleSignOnCredentials
Content-type: application/json

{
  "id": "5793aa3b-cca9-4794-679a240f8b58"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "5793aa3b-cca9-4794-679a240f8b58",
  "credentials": [
    {
      "fieldId": "param_username",
      "value": "myusername",
      "type": "username"
    },
    {
      "fieldId": "param_password",
      "value": null,
      "type": "password"
    }
  ]
}