Auth | Appbox iOS SDK 가이드

Auth

로그인 제공자 목록 조회

SDK가 지원하는 로그인 제공자와 각 제공자의 설정 여부를 조회합니다.

로그인 제공자 목록 조회

AppBox.getAuthProviderDescriptors() -> [AppBoxAuthProviderDescriptor]

Swift
1 for descriptor in AppBox.getAuthProviderDescriptors()
2 where descriptor.configured {
3 showLoginButton(identifier: descriptor.identifier)
4 }
1 for (AppBoxAuthProviderDescriptor *descriptor
2 in [AppBox getAuthProviderDescriptors]) {
3 if (descriptor.configured) {
4 [self showLoginButtonWithIdentifier:descriptor.identifier];
5 }
6 }

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
[AppBoxAuthProviderDescriptor]제공자 descriptor 배열. 즉시 반환됩니다
.type.google, .apple, .kakao, .naver 중 하나
.configured초기화 config에 제공자 설정이 포함됐는지 여부
.identifierUI와 로직에서 사용할 제공자 식별 문자열


제공자를 배열 순서나 enum raw value로 구분하지 않습니다. 로그인 버튼 노출에는 descriptor.configured를 사용합니다. configured == true가 capability나 외부 콘솔 설정의 실제 동작까지 검증한 결과는 아닙니다.

Auth runtime 확인

SNS Login runtime의 포함 여부를 확인합니다.

Auth runtime 확인

AppBox.isAuthAvailable(_ provider: AppBoxAuthProvider) -> Bool

Swift
1 let runtimeAvailable = AppBox.isAuthAvailable(.kakao)
2 let kakaoConfigured = AppBox.getAuthProviderDescriptors()
3 .first(where: { $0.type == .kakao })?
4 .configured ?? false
1 BOOL runtimeAvailable =
2 [AppBox isAuthAvailableForProvider:AppBoxAuthProviderKakao];
3
4 BOOL kakaoConfigured = NO;
5 for (AppBoxAuthProviderDescriptor *descriptor
6 in [AppBox getAuthProviderDescriptors]) {
7 if (descriptor.type == AppBoxAuthProviderKakao) {
8 kakaoConfigured = descriptor.configured;
9 break;
10 }
11 }

Request 항목 정의

Request 항목필수여부설명기본값
provider필수확인할 AppBoxAuthProvider-

Response 항목 정의

Response 결과값
BoolSNS Login runtime 포함 여부. 즉시 반환됩니다


현재 구현은 provider별 설정 완료가 아니라 SNS Login runtime 존재 여부를 반환합니다. 특정 제공자의 버튼 노출 여부는 getAuthProviderDescriptors()의 configured로 확인합니다. 로그인 전 AppBoxInitResult.auth.status도 확인합니다.

Google, Apple, Kakao 로그인

지정한 Google, Apple 또는 Kakao 제공자로 로그인을 시작합니다.

Google, Apple, Kakao 로그인

AppBox.signIn(_ provider: AppBoxAuthProvider, presentingViewController: UIViewController, completion: @escaping (AppBoxUserAuthData?, NSError?) -> Void)

Swift
1 AppBox.signIn(
2 .kakao,
3 presentingViewController: self
4 ) { user, error in
5 if let user {
6 completeLogin(user.uid)
7 } else {
8 showLoginError(error)
9 }
10 }
1 [AppBox signInWithProvider:AppBoxAuthProviderKakao
2 presentingViewController:self
3 completion:^(AppBoxUserAuthData *user, NSError *error) {
4 if (user != nil) {
5 [self completeLogin:user.uid];
6 } else {
7 [self showLoginError:error];
8 }
9 }];

Request 항목 정의

Request 항목필수여부설명기본값
provider필수.google, .apple, .kakao 중 로그인 제공자-
presentingViewController필수provider 로그인 UI를 표시할 view controller-
completion필수로그인 결과 callback-

Response 항목 정의

Response 결과값
user성공 시 uid, email, displayName, photoURL, token 정보를 담은 AppBoxUserAuthData
error사용자 취소, 설정 오류 또는 provider 로그인 실패 원인


Google과 Apple 로그인은 Push/Firebase 초기화가 필요합니다.

  • 제공자별 capability, URL Scheme, 외부 콘솔 설정을 먼저 완료합니다.
  • .naver를 전달하면 .unsupportedProviderInvocation 오류가 발생합니다.
  • 사용자 정보와 provider token을 로그에 남기지 않습니다.

로그아웃

지정한 로그인 제공자의 현재 세션에서 로그아웃합니다.

로그아웃

AppBox.signOut(_ provider: AppBoxAuthProvider, completion: @escaping (Bool, NSError?) -> Void)

Swift
1 AppBox.signOut(.kakao) { success, error in
2 if !success {
3 print(error?.localizedDescription ?? "로그아웃 실패")
4 }
5 }
1 [AppBox signOutWithProvider:AppBoxAuthProviderKakao
2 completion:^(BOOL success, NSError *error) {
3 if (!success) {
4 NSLog(@"%@", error.localizedDescription ?: @"로그아웃 실패");
5 }
6 }];

Request 항목 정의

Request 항목필수여부설명기본값
provider필수로그아웃할 AppBoxAuthProvider-
completion필수로그아웃 처리 결과-

Response 항목 정의

Response 결과값
successprovider 로그아웃 처리 성공 여부
error로그아웃 실패 원인


앱 자체 회원 세션과 provider 세션은 별개이므로 서비스 로그아웃 정책에 맞게 함께 정리합니다. 다른 provider의 로그인 상태는 변경하지 않습니다. 로컬 사용자 데이터 삭제 범위를 앱 정책과 일치시킵니다.

www.naver.com
QR 코드를 촬영하면 입력하신 주소의
앱 예시 화면을 테스트할 수 있습니다.
* 스캔 후 바로 앱 다운로드 이동합니다.