REST Resource: projects.locations.authorizations

리소스: Authorization

Discovery Engine 승인 리소스입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,

  // Union field authorization_config can be only one of the following:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of list of possible types for union field authorization_config.
}
필드
name

string

식별자. 승인의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/authorizations/{authorization}

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1024자(영문 기준)입니다.
displayName

string

필수 항목입니다. 승인 표시 이름입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다.
통합 필드 authorization_config. 승인 구성입니다. authorization_config은 다음 중 하나여야 합니다.
serverSideOauth2

object (ServerSideOAuth2)

서버 측 OAuth2 구성입니다.

ServerSideOAuth2

OAuth2 구성입니다.

JSON 표현 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean
}
필드
clientId

string

필수 항목입니다. OAuth2 클라이언트 ID입니다.
clientSecret

string

필수 항목입니다. OAuth2 클라이언트 보안 비밀번호입니다.

저장 데이터 암호화
tokenUri

string

필수 항목입니다. 클라이언트 승인을 액세스 토큰으로 교환하는 HTTP 엔드포인트입니다.
authorizationUri

string

필수 항목입니다. 사용자가 승인해야 할 때 연결되는 URI입니다. 인증 성공에 필요한 모든 항목(OAuth ID, 추가 플래그 등)을 포함해야 합니다. 예: https://accounts.google.com/o/oauth2/v2/auth?clientId=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&responseType=code&access_type=offline&prompt=consent

redirectUri 매개변수는 Vertex AI Search 프런트엔드에 의해 덮어쓰여집니다.
scopes[]

string

선택사항입니다. 요청할 범위입니다. 예: https://www.googleapis.com/auth/calendar.events 생략하면 승인 URI에 필요한 범위 외에 추가 범위가 요청되지 않습니다. 설정된 경우 사용자 승인을 획득할 때 승인 URI의 범위를 덮어씁니다.
pkceVerificationEnabled

boolean

선택사항입니다. PKCE 확인을 사용 설정할지 여부입니다. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

메서드

acquireUserAuthorization

 최종 사용자 인증 정보와 지정된 리소스로 식별되는 사용자의 저장된 갱신 토큰을 사용하여 생성된 액세스 토큰과 해당 토큰 세부정보를 반환합니다.

create

 Authorization를 생성합니다.

delete

 Authorization를 삭제합니다.

get

 Authorization을 가져옵니다.

list

 Engine 아래의 모든 Authorization를 나열합니다.

patch

 Authorization을 업데이트합니다.

storeUserAuthorization

 OAuth 승인 사용자 인증 정보를 갱신 토큰으로 교환하고, 해당 갱신 토큰과 범위를 저장합니다.