Service Principal Resource to support RelayState

[MarkDordoy]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritise this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritise the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

When setting up an Azure AD Application and service principal for SAML authentication, some applications require a relaystate to be set. This is supported in the portal but not currently via the provider. Once the provider gets migrated to use the AzureAD graph this should be possible as the value is exposed via the api and can be patched to update the value.

It exists in the json response

    "samlSingleSignOnSettings": {
        "relayState": "randomvalues"
    }

New or Affected Resource(s)

• azuread_service_principal

Potential Terraform Configuration

resource "azuread_service_principal" "example" {
  application_id               = azuread_application.example.application_id
  app_role_assignment_required = false
  samlSingleSignOnSettings {
    relaystate = "somevalue"
  }
  tags = ["example", "tags", "here"]
}

References

The API reference is here: https://docs.microsoft.com/en-us/graph/api/serviceprincipal-update?view=graph-rest-1.0&tabs=http

It does not explicitly list about updating the relaystate, however i have tested this myself performing a patch call with the body below and it worked successfully :

{
    "samlSingleSignOnSettings": {
        "relayState": "randomvalues"
    }
}

[github-actions]

This functionality has been released in v2.2.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.