Get governanceRoleSetting
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.
Caution
This version of the Privileged Identity Management (PIM) API for Azure resources will be deprecated soon. Please use the new Azure REST PIM API for Azure resource roles.
Retrieve the properties and relationships of a governanceRoleSetting.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
The following table shows the least privileged permission or permissions required to call this API on each supported resource type. Follow best practices to request least privileged permissions. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
---|---|---|---|
Microsoft Entra ID | PrivilegedAccess.ReadWrite.AzureAD | Not supported. | PrivilegedAccess.Read.AzureAD |
Azure resources | PrivilegedAccess.ReadWrite.AzureResources | Not supported. | PrivilegedAccess.Read.AzureResources |
group | PrivilegedAccess.ReadWrite.AzureADGroup | Not supported. | PrivilegedAccess.Read.AzureADGroup |
The requestor must also have at least one role assignment on the resource which the governanceRoleSetting belongs to.
HTTP request
GET /privilegedAccess/azureResources/roleSettings/{id}
Optional query parameters
This method supports the OData Query Parameters to help customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a governanceRoleSetting object in the response body.
Example
Request
GET https://graph.microsoft.com/beta/privilegedAccess/azureResources/roleSettings/80dc5d6f-8d89-47b3-953f-01dc909ed3f9
Response
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#governanceRoleSettings/$entity",
"id": "80dc5d6f-8d89-47b3-953f-01dc909ed3f9",
"resourceId": "e5e7d29d-5465-45ac-885f-4716a5ee74b5",
"roleDefinitionId": "5b8bea96-e9f6-4c63-a8e9-fb092c79f0a1",
"isDefault": false,
"lastUpdatedDateTime": "2018-03-26T21:21:43.113Z",
"lastUpdatedBy": "Alex Wilber",
"adminEligibleSettings": [
{
"ruleIdentifier": "ExpirationRule",
"setting": "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}"
}
],
"adminMemberSettings": [
{
"ruleIdentifier": "ExpirationRule",
"setting": "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":43200}"
},
{
"ruleIdentifier": "MfaRule",
"setting": "{\"mfaRequired\":false}"
},
{
"ruleIdentifier": "JustificationRule",
"setting": "{\"required\":true}"
}
],
"userEligibleSettings": [],
"userMemberSettings": [
{
"ruleIdentifier": "ExpirationRule",
"setting": "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":480}"
},
{
"ruleIdentifier": "MfaRule",
"setting": "{\"mfaRequired\":false}"
},
{
"ruleIdentifier": "JustificationRule",
"setting": "{\"required\":true}"
},
{
"ruleIdentifier": "ApprovalRule",
"setting": "{\"Enabled\":true,\"Approvers\":[{\"Id\":\"20083cf1-b8d8-43be-9d37-96adfb09e619\",\"Type\":\"User\",\"DisplayName\":\"Alex Wilber\",\"Email\":\"AlexW@contoso.com\"},{\"Id\":\"d158e1b0-5080-4088-a1e7-9ca54f39eb53\",\"Type\":\"User\",\"DisplayName\":\"Alex Wilber\",\"Email\":\"AlexW@contoso.com\"}],\"BusinessFlowId\":\"8df9e93a-6ba9-4453-af43-07cb95435032\"}"
}
]
}