Skip to content

Commit

Permalink
Merge pull request #24985 from microsoftgraph/main
Browse files Browse the repository at this point in the history 
Merge to publish.
  • Loading branch information
@Lauragra
Lauragra authored Aug 17, 2024
2 parents 6bdae68 + 8dda242 commit 67e039c
Show file tree
Hide file tree
Showing 39 changed files with 370 additions and 426 deletions.
54 changes: 37 additions & 17 deletions api-reference/beta/api/application-list-owners.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: "List owners"
description: "Retrieve a list of owners (directoryObject objects) for an application."
title: "List owners of an application"
description: "Retrieve a list of owners for an application."
author: "sureshja"
ms.localizationpriority: medium
ms.subservice: "entra-applications"
doc_type: apiPageType
---

# List owners
# List owners of an application

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) objects.
Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) types.

[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]

Expand All @@ -25,8 +25,6 @@ Choose the permission or permissions marked as least privileged for this API. Us

[!INCLUDE [limited-info](../../includes/limited-info.md)]



## HTTP request

You can address the application 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.
Expand All @@ -37,7 +35,7 @@ GET /applications(appId='{appId}')/owners
```

## Optional query parameters
This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
This method supports the `$count`, `$expand`, `$filter`, `$orderby`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries).

## Request headers
| Name | Description |
Expand All @@ -51,16 +49,16 @@ Don't supply a request body for this method.

If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body.
## Example
##### Request
The following example shows a request.
### Request
The following example shows a request that uses the **appId** alternate key to query the owners of an application.

# [HTTP](#tab/http)
<!-- {
"blockType": "request",
"name": "application_get_owners"
}-->
```msgraph-interactive
GET https://graph.microsoft.com/beta/applications/{id}/owners
GET https://graph.microsoft.com/beta/applications(appId='bbec3106-565f-4907-941e-96b4dbfef21c')/owners
```

# [C#](#tab/csharp)
Expand Down Expand Up @@ -97,8 +95,9 @@ GET https://graph.microsoft.com/beta/applications/{id}/owners

---

##### Response
The following example shows the response. Note: The response object shown here might be shortened for readability.
### Response
The following example shows the response. It shows only the **id** property as populated while other properties as `null`. This is because the caller did not have permissions to read users in the tenant.
>**Note:** The response object shown here might be shortened for readability.
<!-- {
"blockType": "response",
"truncated": true,
Expand All @@ -110,11 +109,32 @@ HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "id-value"
}
]
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects",
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET applications(appId=<key>)/owners?$select=deletedDateTime",
"value": [
{
"@odata.type": "#microsoft.graph.user",
"id": "ce4770b3-70b2-4a38-a242-76631e9f7408",
"businessPhones": [],
"displayName": null,
"givenName": null,
"jobTitle": null,
"mail": null,
"mobilePhone": null,
"officeLocation": null,
"preferredLanguage": null,
"surname": null,
"userPrincipalName": null
},
{
"@odata.type": "#microsoft.graph.user",
"id": "858a9c90-38b3-4e78-b915-234aece712c4",
},
{
"@odata.type": "#microsoft.graph.user",
"id": "7585d967-f300-43de-b817-7119a6404c5e",
}
]
}
```

Expand Down
152 changes: 22 additions & 130 deletions api-reference/beta/api/authenticationeventsflow-update.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only the [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is supported.
Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object by ID. You must specify the **@odata.type** property and the value of the [authenticationEventsFlow](../resources/authenticationeventsflow.md) object type to update. The following derived subtypes are supported:
- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md)

[!INCLUDE [national-cloud-support](../../includes/global-china.md)]

Expand Down Expand Up @@ -55,7 +56,7 @@ You must include the **@odata.type** property with a value of the specific user
|priority|Int32|The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. |
|onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|The configuration for what to invoke for the onInteractiveAuthFlowStart event. |
|onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|The configuration for what to invoke for the onAuthenticationMethodLoadStart event. Must have at least one identity provider linked.|
|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke for the onAttributeCollection event. You can only update this property if it was configured during user flow creation. If it wasn't, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API instead.|
|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke for the onAttributeCollection event. <br/><br/><li> You can only update this property if it was configured during user flow creation. If it wasn't, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API first. </li><li> You can't add or remove attributes by updating the **attributeCollectionPage** > **views** > **inputs** and **attributes** objects. Use the [Add attribute to user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) or [Remove attribute from user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) APIs instead to update both objects.</li><li> To update the **attributeCollectionPage** > **views** > **inputs** collection, you must include all objects in the collection, not only the changed objects. <li> The order of objects in the **attributeCollectionPage** > **views** > **inputs** collection corresponds to the order in which the attributes are displayed on the app's sign-up UI. |
|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|The configuration for what to invoke for the onUserCreateStart event.|

## Response
Expand All @@ -67,7 +68,7 @@ If successful, this method returns a `204 No Content` response code. If unsucces
### Example 1: Update the display name and priority of an authenticationEventsFlow

#### Request
The following example shows a request that updates the display name of a specific external identities user flow (an authentication event type), as well as the priority for all the listeners associated with the policy.
The following example shows a request that updates the display name of a specific external identities user flow, as well as the priority for all the listeners associated with the policy.

# [HTTP](#tab/http)
<!-- {
Expand Down Expand Up @@ -131,9 +132,9 @@ The following example shows the response.
HTTP/1.1 204 No Content
```

### Example 2: Update the onAttributeCollection event of a self-service sign up user flow
### Example 2: Update the page layout of a self-service sign up user flow

Add city (built-in attribute) as an attribute to be collected during the attribute collection step of a self-service sign up user flow. You must specify in the **inputs** object all attributes that you want to retain, otherwise they are removed from the user flow.
The following request updates the configuration of some of the attributes. All the attributes are marked as required; the email attribute is marked as hidden; the input type of the custom attribute is also updated to a radio button with two options.

#### Request

Expand Down Expand Up @@ -178,7 +179,7 @@ Content-Type: application/json
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"required": true,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
Expand All @@ -190,21 +191,30 @@ Content-Type: application/json
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"required": true,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
{
"attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
"label": "Favorite color",
"inputType": "text",
"attribute": "extension_331d514c0c18477583ea7dd5a79feda2_RockorCountry",
"label": "Rock music or Country",
"inputType": "radioSingleSelect",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"required": true,
"validationRegEx": "^.*",
"options": []
"options": [
{
"label": "Rock music",
"value": "Rock"
},
{
"label": "Country music",
"value": "Country"
}
]
}
]
}
Expand Down Expand Up @@ -259,121 +269,3 @@ The following example shows the response.
``` http
HTTP/1.1 204 No Content
```

### Example 3: Remove an attribute collected during a self-service sign up user flow

Remove city as an attribute to be collected during the attribute collection step of a self-service sign up user flow. By excluding the city attribute from the request body, the attribute is removed from the user flow.

#### Request

# [HTTP](#tab/http)
<!-- {
"blockType": "request",
"name": "update_authenticationeventsflow_onattributecollection_beta_e3"
}
-->
``` http
PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
"onAttributeCollection": {
"@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
"attributeCollectionPage": {
"customStringsFileId": null,
"views": [
{
"title": null,
"description": null,
"inputs": [
{
"attribute": "email",
"label": "Email Address",
"inputType": "text",
"defaultValue": null,
"hidden": true,
"editable": false,
"writeToDirectory": true,
"required": true,
"validationRegEx": "^[a-zA-Z0-9.!#$%&amp;&#8217;'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
"options": []
},
{
"attribute": "displayName",
"label": "Display Name",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
{
"attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
"label": "Favorite color",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^.*",
"options": []
}
]
}
]
}
}
}
```

# [C#](#tab/csharp)
[!INCLUDE [sample-code](../includes/snippets/csharp/update-authenticationeventsflow-onattributecollection-beta-e3-csharp-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [CLI](#tab/cli)
[!INCLUDE [sample-code](../includes/snippets/cli/update-authenticationeventsflow-onattributecollection-beta-e3-cli-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [Go](#tab/go)
[!INCLUDE [sample-code](../includes/snippets/go/update-authenticationeventsflow-onattributecollection-beta-e3-go-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [Java](#tab/java)
[!INCLUDE [sample-code](../includes/snippets/java/update-authenticationeventsflow-onattributecollection-beta-e3-java-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [JavaScript](#tab/javascript)
[!INCLUDE [sample-code](../includes/snippets/javascript/update-authenticationeventsflow-onattributecollection-beta-e3-javascript-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [PHP](#tab/php)
[!INCLUDE [sample-code](../includes/snippets/php/update-authenticationeventsflow-onattributecollection-beta-e3-php-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [PowerShell](#tab/powershell)
[!INCLUDE [sample-code](../includes/snippets/powershell/update-authenticationeventsflow-onattributecollection-beta-e3-powershell-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

# [Python](#tab/python)
[!INCLUDE [sample-code](../includes/snippets/python/update-authenticationeventsflow-onattributecollection-beta-e3-python-snippets.md)]
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]

---

#### Response

The following example shows the response.
<!-- {
"blockType": "response",
"truncated": true
}
-->
``` http
HTTP/1.1 204 No Content
```

4 changes: 2 additions & 2 deletions api-reference/beta/api/cloudpc-getfrontlinecloudpcaccessstate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",
"value": "noLicensesAvailable"
"value": "active"
}
```

Expand Down Expand Up @@ -197,6 +197,6 @@ Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",
"value": "noLicensesAvailable"
"value": "active"
}
```
2 changes: 1 addition & 1 deletion api-reference/beta/api/identitycontainer-post-authenticationeventsflows.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can specify the following properties when creating an **authenticationEvents
|priority|Int32|Optional. The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. Default is 500. |
|onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. The configuration for what to invoke when an authentication flow is ready to be initiated. |
|onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked.|
|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property when it wasn't configured during user flow creation, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API.|
|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property, you must specify both **attributes** and **onAttributeCollectionPage** > **views** objects.|
|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|Optional. The configuration for what to invoke during user creation.|

## Response
Expand Down
Loading

0 comments on commit 67e039c

Please sign in to comment.