portone_server_sdk.auth

portone_server_sdk.auth#

Classes

LoginViaApiSecretBody

API Secret 로그인을 위한 입력 정보

LoginViaApiSecretResponse

API key 로그인 성공 응답

RefreshTokenBody

토큰 재발급을 위한 입력 정보

RefreshTokenResponse

토큰 재발급 성공 응답

AuthClient

class portone_server_sdk.auth.LoginViaApiSecretBody#

API Secret 로그인을 위한 입력 정보

api_secret: str#

발급받은 API secret

class portone_server_sdk.auth.LoginViaApiSecretResponse#

API key 로그인 성공 응답

access_token: str#

인증에 사용하는 엑세스 토큰

하루의 유효기간을 가지고 있습니다.

refresh_token: str#

토큰 재발급 및 유효기간 연장을 위해 사용하는 리프레시 토큰

일주일의 유효기간을 가지고 있으며, 리프레시 토큰을 통해 유효기간이 연장된 새로운 엑세스 토큰을 발급받을 수 있습니다.

class portone_server_sdk.auth.RefreshTokenBody#

토큰 재발급을 위한 입력 정보

refresh_token: str#

리프레시 토큰

class portone_server_sdk.auth.RefreshTokenResponse#

토큰 재발급 성공 응답

access_token: str#

인증에 사용하는 엑세스 토큰

하루의 유효기간을 가지고 있습니다.

refresh_token: str#

토큰 재발급 및 유효기간 연장을 위해 사용하는 리프레시 토큰

일주일의 유효기간을 가지고 있으며, 리프레시 토큰을 통해 유효기간이 연장된 새로운 엑세스 토큰을 발급받을 수 있습니다.

class portone_server_sdk.auth.AuthClient#
login_via_api_secret(*, api_secret: str) → LoginViaApiSecretResponse#

API secret 를 사용한 토큰 발급

API secret 를 통해 API 인증에 사용할 토큰을 가져옵니다.

Parameters:

api_secret (str) – 발급받은 API secret

Raises:

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async login_via_api_secret_async(*, api_secret: str) → LoginViaApiSecretResponse#

API secret 를 사용한 토큰 발급

API secret 를 통해 API 인증에 사용할 토큰을 가져옵니다.

Parameters:

api_secret (str) – 발급받은 API secret

Raises:

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

refresh_token(*, refresh_token: str) → RefreshTokenResponse#

토큰 갱신

리프레시 토큰을 사용해 유효기간이 연장된 새로운 토큰을 재발급합니다.

Parameters:

refresh_token (str) – 리프레시 토큰

Raises:

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async refresh_token_async(*, refresh_token: str) → RefreshTokenResponse#

토큰 갱신

리프레시 토큰을 사용해 유효기간이 연장된 새로운 토큰을 재발급합니다.

Parameters:

refresh_token (str) – 리프레시 토큰

Raises:

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

Contents