다음을 통해 공유


AuthorizationServerContractProperties interface

외부 OAuth 권한 부여 서버 설정 속성입니다.

Extends

속성

authorizationEndpoint

OAuth 권한 부여 엔드포인트입니다. http://tools.ietf.org/html/rfc6749#section-3.2을 참조하세요.

clientId

이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 ID입니다.

clientRegistrationEndpoint

이 권한 부여 서버에 대한 클라이언트 또는 앱 등록을 수행하는 페이지의 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.

clientSecret

이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. 값을 얻으려면 '/listSecrets' POST 요청을 사용합니다.

displayName

사용자에게 친숙한 권한 부여 서버 이름입니다.

grantTypes

클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.

useInApiDocumentation

true이면 권한 부여 서버가 개발자 포털의 API 설명서에서 사용됩니다. 값이 제공되지 않으면 기본적으로 False입니다.

useInTestConsole

true이면 개발자 포털 테스트 콘솔에서 권한 부여 서버를 사용할 수 있습니다. 값이 제공되지 않으면 기본적으로 True입니다.

상속된 속성

authorizationMethods

권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.

bearerTokenSendingMethods

액세스 토큰을 API로 전달하는 메커니즘을 지정합니다.

clientAuthenticationMethod

이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.

defaultScope

기본적으로 요청되는 액세스 토큰 범위입니다. API 수준에서 재정의할 수 있습니다. 공백으로 구분된 값을 포함하는 문자열 형식으로 제공해야 합니다.

description

권한 부여 서버의 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

resourceOwnerPassword

이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.

resourceOwnerUsername

이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.

supportState

true인 경우 권한 부여 서버에는 권한 부여 요청의 상태 매개 변수가 해당 응답에 포함됩니다. 클라이언트는 프로토콜 보안을 강화하는 데 상태 매개 변수를 사용할 수 있습니다.

tokenBodyParameters

이름 및 값 문자열 속성이 있는 JSON 개체의 배열로 표시되는 이 권한 부여 서버의 토큰 엔드포인트에 필요한 추가 매개 변수(예: {"name" : "name value", "value": "a value"}).

tokenEndpoint

OAuth 토큰 엔드포인트입니다. 참조되는 엔터티에 대한 절대 URI를 포함합니다.

속성 세부 정보

authorizationEndpoint

OAuth 권한 부여 엔드포인트입니다. http://tools.ietf.org/html/rfc6749#section-3.2을 참조하세요.

authorizationEndpoint: string

속성 값

string

clientId

이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 ID입니다.

clientId: string

속성 값

string

clientRegistrationEndpoint

이 권한 부여 서버에 대한 클라이언트 또는 앱 등록을 수행하는 페이지의 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.

clientRegistrationEndpoint: string

속성 값

string

clientSecret

이 권한 부여 서버와 함께 등록되는 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. 값을 얻으려면 '/listSecrets' POST 요청을 사용합니다.

clientSecret?: string

속성 값

string

displayName

사용자에게 친숙한 권한 부여 서버 이름입니다.

displayName: string

속성 값

string

grantTypes

클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.

grantTypes: string[]

속성 값

string[]

useInApiDocumentation

true이면 권한 부여 서버가 개발자 포털의 API 설명서에서 사용됩니다. 값이 제공되지 않으면 기본적으로 False입니다.

useInApiDocumentation?: boolean

속성 값

boolean

useInTestConsole

true이면 개발자 포털 테스트 콘솔에서 권한 부여 서버를 사용할 수 있습니다. 값이 제공되지 않으면 기본적으로 True입니다.

useInTestConsole?: boolean

속성 값

boolean

상속된 속성 세부 정보

authorizationMethods

권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.

authorizationMethods?: AuthorizationMethod[]

속성 값

AuthorizationServerContractBaseProperties.authorizationMethods에서 상속

bearerTokenSendingMethods

액세스 토큰을 API로 전달하는 메커니즘을 지정합니다.

bearerTokenSendingMethods?: string[]

속성 값

string[]

AuthorizationServerContractBaseProperties.bearerTokenSendingMethods에서 상속

clientAuthenticationMethod

이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.

clientAuthenticationMethod?: string[]

속성 값

string[]

AuthorizationServerContractBaseProperties.clientAuthenticationMethod에서 상속됨

defaultScope

기본적으로 요청되는 액세스 토큰 범위입니다. API 수준에서 재정의할 수 있습니다. 공백으로 구분된 값을 포함하는 문자열 형식으로 제공해야 합니다.

defaultScope?: string

속성 값

string

AuthorizationServerContractBaseProperties.defaultScope에서 상속됨

description

권한 부여 서버의 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

description?: string

속성 값

string

AuthorizationServerContractBaseProperties.description에서 상속됨

resourceOwnerPassword

이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.

resourceOwnerPassword?: string

속성 값

string

AuthorizationServerContractBaseProperties.resourceOwnerPassword에서 상속됨

resourceOwnerUsername

이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.

resourceOwnerUsername?: string

속성 값

string

AuthorizationServerContractBaseProperties.resourceOwnerUsername에서 상속됨

supportState

true인 경우 권한 부여 서버에는 권한 부여 요청의 상태 매개 변수가 해당 응답에 포함됩니다. 클라이언트는 프로토콜 보안을 강화하는 데 상태 매개 변수를 사용할 수 있습니다.

supportState?: boolean

속성 값

boolean

AuthorizationServerContractBaseProperties.supportState에서 상속됨

tokenBodyParameters

이름 및 값 문자열 속성이 있는 JSON 개체의 배열로 표시되는 이 권한 부여 서버의 토큰 엔드포인트에 필요한 추가 매개 변수(예: {"name" : "name value", "value": "a value"}).

tokenBodyParameters?: TokenBodyParameterContract[]

속성 값

AuthorizationServerContractBaseProperties.tokenBodyParameters에서 상속

tokenEndpoint

OAuth 토큰 엔드포인트입니다. 참조되는 엔터티에 대한 절대 URI를 포함합니다.

tokenEndpoint?: string

속성 값

string

AuthorizationServerContractBaseProperties.tokenEndpoint에서 상속됨