Clients

Overview

Client Management is a feature to control all of the applications that are integrated with your resources. As an admin, you can manage all of your clients data and organize which resources that a client can access as well as revoking them. If this feature is connected with the session management API gateway, you can have a combination of security countermeasures to prevent a bad impact that may cause danger to your resources.

Tutorials

Create a Game or Backend Service Client

This tutorial shows you how to create either a game client or a backend service client. Follow the instructions carefully to ensure that you input the correct information for the type of client you want to create.

Create a Game or Backend Service Client Using the API Gateway

To create a game or backend service client, follow the steps below.

  1. Use the Create Client: POST /iam/v3/admin/namespaces/{namespace}/clients endpoint.

  2. Input the Namespace to which you want to add the client.

    • If you are making a game client, input the game namespace.
    • If you are making a backend service client, input the publisher namespace.
  3. Fill in the Request Body.

    a. Input list of target client IDs that will receive the token in the Audiences field, e.g ["eaaa65618fe24293b00a61454182b435", "40073ee9bc3446d3a051a71b48509a5d"]

    b. Input the base URI of the client application, to ensure that the token can be used by the client. e.g https://example.net/platform.

    c. Input the Client ID, e.g f815e5c44f364993961be3b3f26a7bf4

    d. Input the Client Name, e.g E-commerce

    e. Fill in the Client Permissions.

    • Input the Action needed for the permission.

    • Input the Resource you want to access with the appropriate formatting.

      The following parameters are optional; they can be used to schedule permissions that are granted on a temporary basis.

      • Input the desired action value into the SchedAction field.
      • For recurring permissions, input the desired string or date range in UTC into the SchedCron field.
      • Input the start and end dates for the permission into the SchedRange field.

    f. Input the namespace into the Namespace field.

    g. Input the appropriate client type into the oauthClientType field. For game use Public and backend service clients, use the Confidential client type.

Create a Game or Backend Service Client Through the Admin Portal

  1. In the Admin Portal, go to the Platform Configuration section and click the OAuth Clients menu.

    Clients Management
  2. In the OAuth Clients page, make sure that you are in the right namespace. Then, click Create New.

    Clients Management
  3. Fill in the fields required by your client type:

    • To create a game client, choose the Game Namespace and Public Client Type.
    • To create a backend service client, choose the Publisher Namespace and Confidential Client Type.
    Clients ManagementClients Management
  4. When you’re finished, click Create. Your new client will be added to the client list.

Create an SPA Client

Create an SPA Client Using the API Gateway

  1. Use the Create SPA Client: POST /iam/v3/admin/namespaces/{namespace}/clients endpoint.

  2. Input the Namespace to which you want to add the client.

    • If you are making a game client, input the game namespace.
    • If you are making a backend service client, input the publisher namespace.
  3. Fill in the Request Body.

    a. Input list of target client IDs that will receive the token in the Audiences field, e.g ["eaaa65618fe24293b00a61454182b435", "40073ee9bc3446d3a051a71b48509a5d"]

    b. Input the base URI of the client application, to ensure that the token can be used by the client. e.g https://example.net/platform.

    c. Input the Client ID, e.g f815e5c44f364993961be3b3f26a7bf4

    d. Input the Client Name, e.g E-commerce

    e. Fill in the Client Permissions.

    • Input the Action needed for permission.

    • Input the Resource you want to access with the appropriate fields.

      The following parameters are optional; they can be used to schedule permissions that are granted on a temporary basis.

      • Input the desired action value into the SchedAction field.
      • For recurring permissions, input the desired string or date range in UTC into the SchedCron field.
      • Input the start and end dates for the permission into the SchedRange field.

    f. Input the namespace into the Namespace field.

    g. Input the appropriate client type into the oauthClientType field. For SPA Client, use the Public client type.

Upon successful request, the client will be generated in the desired namespace.

Create an SPA Client Through the Admin Portal

The procedure is similar to the procedure to create a Game or Backend Service Client.

  1. Before creating the clients make sure you are in the right namespace in the Admin Portal. Then, click the Create New button.

    Clients Management
  2. Fill in the required fields according to the client type. To create an SPA Client, choose the Public client type.

    Clients Management
  3. When you’re finished, click Create. Your new client will be added to the list.

What’s Next?

  • For more information about Client Management you can access the API references.