Skip to content

Latest commit

 

History

History
141 lines (101 loc) · 5.51 KB

identityuserflowattribute-post.md

File metadata and controls

141 lines (101 loc) · 5.51 KB
Raw
title description ms.localizationpriority doc_type author ms.subservice
Create identityUserFlowAttribute
Create a new custom identityUserFlowAttribute object.
medium
apiPageType
nanguil
entra-sign-in

Create identityUserFlowAttribute

Namespace: microsoft.graph

Create a new custom identityUserFlowAttribute object.

[!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-user-flows-attributes-apis]

HTTP request

POST /identity/userFlowAttributes

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 representation of identityUserFlowAttribute.

Property Type Description
id String The identifier of the user flow attribute. This is a read-only attribute that is automatically created.
displayName String The display name of the user flow attribute.
description String The description of the user flow attribute. It's shown to the user at the time of sign-up.
userFlowAttributeType String The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property are builtIn or custom.
dataType String The data type of the user flow attribute. This can't be modified once the custom user flow attribute is created. The supported values for dataType are:
  • string
  • boolean
  • int64

Response

If successful, this method returns a 201 Created response code and identityUserFlowAttribute object in the response body. If unsuccessful, a 4xx error is returned with specific details.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/identity/userFlowAttributes
Content-type: application/json

{
  "displayName": "Hobby",
  "description": "Your hobby",
  "dataType": "string"
}

C#

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

CLI

[!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 201 Created
Location: "/identity/userFlowAttributes('extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby')"
Content-type: application/json

{
    "id": "extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby",
    "displayName": "Hobby",
    "description": "Your hobby",
    "userFlowAttributeType": "custom",
    "dataType": "string"
}