Skip to main content

User Activities

Create User​

  • General Info:

    • To create a new user, the username and email values should be unique and did not been used.
    • The created users will be displayed on your IDP service in real-time, and can be configured as desired.

  • Performing the API Request and Response:

    • To get more information about the request body configurations and responses, you could check the Create User API methods.

  • Sample of Request Body:

    • Configure the request body parameters as outlined below and ensure that the specified parameters in the request body are set up according to the provided guidelines.
    { 
    "username": "testUser",
    "email": "adminBank@kobil.com", 
    "enabled": true, 
    "emailVerified": false, 
    "firstName": "test", 
    "lastName": "adminBank" 
    }

Update User​

  • General Info:

    • To change user's password and so on, the user name needs to be included in the request call.
    • In Postman request body, you are able to configure the newly created password as desired with the value parameter.

  • Performing the API Request and Response:

    • For more information about the request body configurations and responses, you could check the Update User API methods.

⚠️NOTE: Since the format of the created passwords will be clear-text. The method should not be used for users created under the BDDK regulations.

Get User by Name​

  • General Info:

    • The API call allows you to access real-time user data, providing flexibility for further configuration within your IDP service.

  • Performing the API Request and Response:

    • To get more information about the request body configurations and responses, you could check the Get User by Name API methods.

Get User by UUID​

  • General Info:

    • This API call facilitates the retrieval of user details based on their unique UUID, offering real-time insights for further configuration within your IDP service.

  • Performing the API Request and Response:

    • For more information about the request body configurations and responses, please follow the Get User by UUID API methods.

Create Activation Code​

  • General Info:

    • In Postman request call, you can configure the activation code values by using the secretData parameter.
    • The validity period of the generated activation code is determined by credentialData. e.g. 60 days(60d), 60 minutes(60m), 60 seconds(60s).

  • Performing the Request:

    • To create an activation code by utilizing the Activation Code API use following request:
    PUT https://idp.{{baseUrl}}/auth/admin/realms/{{tenant}}/users/{{app_user_uuid}}

  • Request Body:

    • Configure the request body parameters as outlined below and ensure that the specified parameters in the request body are set up according to the provided guidelines.
    { 
       "credentials" : [ 
           {    
               "type" : "ACTIVATION_CODE", 
               "credentialData" : "{\"period\" : \"60d\"}", 
               "secretData" : "{\"code\" : \"68493536\"}"
           } 
       ]
    }

  • Sample Response:

Get Client Device with UUID​

  • General Info:

    • To execute the request call, please filled in the app user IDs.
    • The API call allows you to access real-time client device details, and it's unique ID.

  • Performing the API Request and Response:

    • For more information about the request body configurations and responses, please follow the Get Linked Clients API methods.

  • General Info:

    • The Client Device ID needs to be included in the request body, to unlink the specified users.

  • Performing the API Request and Response:

    • To get more information about the request body configurations and responses, please follow the Unlink User API methods.

⚠️NOTE: Since the same user can perform activation on multiple devices, the ID of the app user and Client Device must be presented in the request body.

Delete User​

  • General Info:

    • To delete an existing user, an UUID of the user is required.
    • The deleted users will not be displayed on your IDP service anymore.

  • Performing the API Request and Response:

    • For more information about the request body configurations and responses, please follow the Delete User API methods.