Share via

User - Create Or Update

  • 참조
Service:
API Management
API Version:
2022-08-01

사용자를 만들거나 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
With optional parameters: 
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?notify={notify}&api-version=2022-08-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
 path True

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName
 path True

string

API Management 서비스의 이름입니다.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

대상 구독의 ID입니다.
userId
 path True

string

사용자 식별자 현재 API Management 서비스 instance 고유해야 합니다.
api-version
 query True

string

이 작업에 사용할 API 버전입니다.
notify
 query

boolean

사용자에게 Email 알림을 보냅니다.

요청 헤더

Name 필수 형식 Description
If-Match

string

엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name 필수 형식 Description
properties.email True

string

메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다.
properties.firstName True

string

이름입니다.
properties.lastName True

string

성입니다.
properties.appType

AppType

사용자 만들기 요청을 보내는 애플리케이션 유형을 결정합니다. 기본값은 레거시 포털입니다.
properties.confirmation

Confirmation

새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
properties.identities

UserIdentityContract[]

사용자 ID의 컬렉션입니다.
properties.note

string

사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.password

string

사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다.
properties.state

UserState

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

응답

Name 형식 Description
200 OK

UserContract

사용자가 성공적으로 업데이트되었습니다.

Headers

ETag: string
201 Created

UserContract

사용자가 성공적으로 만들어졌습니다.

Headers

ETag: string
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementCreateUser

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-08-01

{
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "confirmation": "signup"
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}
Status code:
200 
{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}

정의

Name Description
AppType

사용자 만들기 요청을 보내는 애플리케이션 유형을 결정합니다. 기본값은 레거시 포털입니다.
Confirmation

새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
ErrorFieldContract

오류 필드 계약입니다.
ErrorResponse

오류 응답.
GroupContractProperties

그룹 계약 속성입니다.
GroupType

그룹 유형.
UserContract

사용자 세부 정보.
UserCreateParameters

사용자가 세부 정보를 만듭니다.
UserIdentityContract

사용자 ID 세부 정보입니다.
UserState

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

AppType

사용자 만들기 요청을 보내는 애플리케이션 유형을 결정합니다. 기본값은 레거시 포털입니다.

Name 형식 Description
developerPortal

string

사용자 만들기 요청이 새 개발자 포털에서 전송되었습니다.
portal

string

레거시 개발자 포털에서 사용자 만들기 요청을 보냈습니다.

Confirmation

새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.

Name 형식 Description
invite

string

등록하고 등록을 완료하도록 사용자를 초대하는 전자 메일을 보냅니다.
signup

string

성공적으로 등록되었는지 확인하는 전자 메일을 사용자에게 보냅니다.

ErrorFieldContract

오류 필드 계약입니다.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.
message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details

ErrorFieldContract[]

유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message

string

사람이 읽을 수 있는 오류 표현입니다.

GroupContractProperties

그룹 계약 속성입니다.

Name 형식 Description
builtIn

boolean

그룹이 세 시스템 그룹(관리자, 개발자 또는 게스트) 중 하나이면 true입니다. 그렇지 않으면 false입니다.
description

string

그룹 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
displayName

string

그룹 이름입니다.
externalId

string

외부 그룹의 경우 이 속성은 외부 ID 공급자의 그룹 ID(예: Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>)를 포함하고, 그렇지 않으면 값이 null입니다.
type

GroupType

그룹 유형.

GroupType

그룹 유형.

Name 형식 Description
custom

string

external

string

system

string

UserContract

사용자 세부 정보.

Name 형식 기본값 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

리소스의 이름입니다.
properties.email

string

메일 주소입니다.
properties.firstName

string

이름입니다.
properties.groups

GroupContractProperties[]

그룹 사용자의 컬렉션은 의 일부입니다.
properties.identities

UserIdentityContract[]

사용자 ID의 컬렉션입니다.
properties.lastName

string

성입니다.
properties.note

string

사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.registrationDate

string

사용자 등록 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.state

UserState

active

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.
type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

UserCreateParameters

사용자가 세부 정보를 만듭니다.

Name 형식 기본값 Description
properties.appType

AppType

사용자 만들기 요청을 보내는 애플리케이션 유형을 결정합니다. 기본값은 레거시 포털입니다.
properties.confirmation

Confirmation

새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
properties.email

string

메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다.
properties.firstName

string

이름입니다.
properties.identities

UserIdentityContract[]

사용자 ID의 컬렉션입니다.
properties.lastName

string

성입니다.
properties.note

string

사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.password

string

사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다.
properties.state

UserState

active

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

UserIdentityContract

사용자 ID 세부 정보입니다.

Name 형식 Description
id

string

공급자 내의 식별자 값입니다.
provider

string

ID 공급자 이름입니다.

UserState

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

Name 형식 Description
active

string

사용자 상태가 활성 상태입니다.
blocked

string

사용자가 차단됩니다. 차단된 사용자는 개발자 포털에서 인증하거나 API를 호출할 수 없습니다.
deleted

string

사용자 계정이 닫힙니다. 모든 ID 및 관련 엔터티가 제거됩니다.
pending

string

사용자 계정이 보류 중입니다. ID를 활성화하려면 ID 확인이 필요합니다.