Skip to content

Latest commit

 

History

History
175 lines (123 loc) · 8.25 KB

README.md

File metadata and controls

175 lines (123 loc) · 8.25 KB

AuthV1

(authV1())

Overview

Operations that allow you to generate a Hathora-signed JSON web token (JWT) for player authentication.

Available Operations

loginAnonymous

Returns a unique player token for an anonymous user.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.LoginAnonymousResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
            .build();

        LoginAnonymousResponse res = sdk.authV1().loginAnonymous()
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .call();

        if (res.playerTokenObject().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ N/A app-af469a92-5b45-4565-b3c4-b79878de67d2

Response

LoginAnonymousResponse

Errors

Error Type Status Code Content Type
models/errors/ApiError 404, 429 application/json
models/errors/SDKError 4XX, 5XX */*

loginGoogle

Returns a unique player token using a Google-signed OIDC idToken.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.LoginGoogleResponse;
import dev.hathora.cloud_sdk.models.shared.GoogleIdTokenObject;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
            .build();

        LoginGoogleResponse res = sdk.authV1().loginGoogle()
                .googleIdTokenObject(GoogleIdTokenObject.builder()
                    .idToken("eyJhbGciOiJSUzI1NiIsImtpZCI6ImZkNDhhNzUxMzhkOWQ0OGYwYWE2MzVlZjU2OWM0ZTE5NmY3YWU4ZDYiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJhY2NvdW50cy5nb29nbGUuY29tIiwiYXpwIjoiODQ4NDEyODI2Nzg4LW00bXNyYjZxNDRkbTJ1ZTNrZ3Z1aTBmcTdrZGE1NWxzLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiYXVkIjoiODQ4NDEyODI2Nzg4LW00bXNyYjZxNDRkbTJ1ZTNrZ3Z1aTBmcTdrZGE1NWxzLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwic3ViIjoiMTE0NTQyMzMwNzI3MTU2MTMzNzc2IiwiZW1haWwiOiJocGFdkeivmeuzQGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJhdF9oYXNoIjoidno1NGhhdTNxbnVR")
                    .build())
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .call();

        if (res.playerTokenObject().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
googleIdTokenObject GoogleIdTokenObject ✔️ N/A
appId Optional<String> ➖ N/A app-af469a92-5b45-4565-b3c4-b79878de67d2

Response

LoginGoogleResponse

Errors

Error Type Status Code Content Type
models/errors/ApiError 401, 404, 422, 429 application/json
models/errors/SDKError 4XX, 5XX */*

loginNickname

Returns a unique player token with a specified nickname for a user.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.LoginNicknameResponse;
import dev.hathora.cloud_sdk.models.shared.NicknameObject;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
            .build();

        LoginNicknameResponse res = sdk.authV1().loginNickname()
                .nicknameObject(NicknameObject.builder()
                    .nickname("squiddytwoshoes")
                    .build())
                .appId("app-af469a92-5b45-4565-b3c4-b79878de67d2")
                .call();

        if (res.playerTokenObject().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
nicknameObject NicknameObject ✔️ N/A
appId Optional<String> ➖ N/A app-af469a92-5b45-4565-b3c4-b79878de67d2

Response

LoginNicknameResponse

Errors

Error Type Status Code Content Type
models/errors/ApiError 404, 422, 429 application/json
models/errors/SDKError 4XX, 5XX */*