servicePrincipal: updatePasswordSingleSignOnCredentials

Article
07/20/2022
4 minutes to read

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update single sign-on credentials using a password for a user or group.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Application.ReadWrite.All and Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Application.ReadWrite.All and Directory.Read.All, Directory.ReadWrite.All

Note

Users can create credentials for themselves. Service principal owners and admins with the following roles can create credentials for any user or group: GlobalAdministrator, ApplicationAdministrator, CloudApplicationAdministrator. To learn more, see Directory roles.

HTTP request

POST /servicePrincipals/{id}/updatePasswordSingleSignOnCredentials

Request headers

Name	Description
Authorization	Bearer {token}. Required.
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.
credentials	credential collection	A list of credential objects that define the complete sign in flow.

Response

If successful, this method returns a 204 No Content response code. It does not return anything in the response body.

Examples

Request

The following is an example of a request.

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

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


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var id = "5793aa3b-cca9-4794-679a240f8b58";

var credentials = new List<Credential>()
{
	new Credential
	{
		FieldId = "param_username",
		Value = "myusername",
		Type = "username"
	},
	new Credential
	{
		FieldId = "param_password",
		Value = "pa$$w0rd",
		Type = "password"
	}
};

await graphClient.ServicePrincipals["{servicePrincipal-id}"]
	.UpdatePasswordSingleSignOnCredentials(id,credentials)
	.Request()
	.PostAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const updatePasswordSingleSignOnCredentials = {
  id: '5793aa3b-cca9-4794-679a240f8b58',
  credentials: [
    {
      fieldId: 'param_username',
      value: 'myusername',
      type: 'username'
    },
    {
      fieldId: 'param_password',
      value: 'pa$$w0rd',
      type: 'password'
    }
  ]
};

await client.api('/servicePrincipals/{id}/updatePasswordSingleSignOnCredentials')
	.version('beta')
	.post(updatePasswordSingleSignOnCredentials);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String id = "5793aa3b-cca9-4794-679a240f8b58";

LinkedList<Credential> credentialsList = new LinkedList<Credential>();
Credential credentials = new Credential();
credentials.fieldId = "param_username";
credentials.value = "myusername";
credentials.type = "username";

credentialsList.add(credentials);
Credential credentials1 = new Credential();
credentials1.fieldId = "param_password";
credentials1.value = "pa$$w0rd";
credentials1.type = "password";

credentialsList.add(credentials1);

graphClient.servicePrincipals("{id}")
	.updatePasswordSingleSignOnCredentials(ServicePrincipalUpdatePasswordSingleSignOnCredentialsParameterSet
		.newBuilder()
		.withId(id)
		.withCredentials(credentialsList)
		.build())
	.buildRequest()
	.post();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewUpdatePasswordSingleSignOnCredentialsPostRequestBody()
id := "5793aa3b-cca9-4794-679a240f8b58"
requestBody.SetId(&id) 


credential := graphmodels.NewCredential()
additionalData := map[string]interface{}{
	"fieldId" : "param_username", 
	"value" : "myusername", 
	"type" : "username", 
}
credential.SetAdditionalData(additionalData)
credential1 := graphmodels.NewCredential()
additionalData := map[string]interface{}{
	"fieldId" : "param_password", 
	"value" : "pa$$w0rd", 
	"type" : "password", 
}
credential1.SetAdditionalData(additionalData)

credentials := []graphmodels.Credentialable {
	credential,
	credential1,

}
requestBody.SetCredentials(credentials)

graphClient.ServicePrincipalsById("servicePrincipal-id").UpdatePasswordSingleSignOnCredentials().Post(requestBody)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Applications

$params = @{
	Id = "5793aa3b-cca9-4794-679a240f8b58"
	Credentials = @(
		@{
			FieldId = "param_username"
			Value = "myusername"
			Type = "username"
		}
		@{
			FieldId = "param_password"
			Value = "pa$$w0rd"
			Type = "password"
		}
	)
}

Update-MgServicePrincipalPasswordSingleSignOnCredentials -ServicePrincipalId $servicePrincipalId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new UpdatePasswordSingleSignOnCredentialsPostRequestBody();
$requestBody->setId('5793aa3b-cca9-4794-679a240f8b58');

$credentialsCredential1 = new Credential();
$additionalData = [
'fieldId' => 'param_username', 
'value' => 'myusername', 
'type' => 'username', 
];
$credentialsCredential1->setAdditionalData($additionalData);



$credentialsArray []= $credentialsCredential1;
$credentialsCredential2 = new Credential();
$additionalData = [
'fieldId' => 'param_password', 
'value' => 'pa$$w0rd', 
'type' => 'password', 
];
$credentialsCredential2->setAdditionalData($additionalData);



$credentialsArray []= $credentialsCredential2;
$requestBody->setCredentials($credentialsArray);




$graphServiceClient->servicePrincipalsById('servicePrincipal-id')->updatePasswordSingleSignOnCredentials()->post($requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

HTTP/1.1 204 No Content

servicePrincipal: updatePasswordSingleSignOnCredentials

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback