Kihagyás

User API V2

ChaingunUser2API WSDL letöltése

Find users

Felhasználók keresése.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
limit Integer A keresési találatok maximális száma.
offset Integer A találati lista kezdete.
userName String Felhasználónév.
name String A felhasználó neve.
email String A felhasználó email címe.
clientNames String [ ] A kliensek nevei.
statuses String [ ] A felhasználók státuszai.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
total Integer Találatok száma.
users User_V1 [ ] A megtalált felhasználók.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.user.api.chaingun.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:findUsers>
         <request>
            <requestMeta>
               <clientHashKey>teszt222</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <userName>teszt@dbx.hu</userName>
            <name>Teszt Elek</name>
            <email>teszt@dbx.hu</email>
            <statuses>
               <status>UNACTIVATED</status>
            </statuses>
         </request>
      </ws:findUsers>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <S:Body>
      <ns2:findUsersResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params/>
            <total>1</total>
            <users>
               <user>
                  <email>teszt@dbx.hu</email>
                  <name>Teszt</name>
                  <roles/>
                  <status>UNACTIVATED</status>
                  <userName>teszt@dbx.hu</userName>
                  <uuid>b169bfda-fe02-462f-9cc8-a887d140ed76</uuid>
               </user>
            </users>
         </response>
      </ns2:findUsersResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/user/v2/users

Paraméter Típus Leírás
limit Integer A keresési találatok maximális száma.
offset Integer A találati lista kezdete.
sort String Rendezés.
clientHashKey String A hívó kliens azonosítója.
userName String A felhasználó neve.
params Param_V1 [ ] Egyéb meta adatok.
userName String Felhasználónév.
name String A felhasználó neve.
email String A felhasználó email címe.
clientNames String [ ] A kliensek nevei.
statuses String [ ] A felhasználók státuszai.

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JUser2 [ ] A megtalált felhasználók.

Minta

GET: hammy/json/user/v2/users
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
Content-Type: application/json
X-User-Name: {{userName}}

{
   "uuid":"b169bfda-fe02-462f-9cc8-a887d140ed76",
   "userName":"teszt@dbx.hu",
   "name":"Teszt",
   "status":"UNACTIVATED",
   "email":"teszt@dbx.hu"
}

HTTP/1.1 200 OK
Content-Type:   application/vnd.api+json

{
    "data": [
        {
            "type": "users",
            "id": "b29d8f0f-a936-4c09-aa74-8057ccb194a9",
            "attributes": {
                "userName": "Teszt_250103",
                "name": "Teszt_250103",
                "primaryOrganizationUuid": "default",
                "status": "UNACTIVATED",
                "email": "teszt@gmail.com",
                "realmCode": "chaingun_default",
                "roles": [
                    "doky_editor",
                    "doky_viewer",
                    "doky_admin",
                    "hammy_viewer"
                ],
                "organizationUuids": [
                    "default",
                    "31bc7c3f-eb41-455f-8934-23e8f1e05f3a",
                    "8d713911-6176-4004-8079-a0c75a1b1dec"
                ]
            }
        },
            "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show user

Visszaadja a megadott azonosítójú felhasználó adatait.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
userName String Felhasználónév.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
user User_V1 A megtalált felhasználó.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.user.api.chaingun.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:showUser>
         <request>
            <requestMeta>
               <clientHashKey>{{clientHashKey}}</clientHashKey>
               <userName>gipsz.jakab</userName>
            </requestMeta>
            <userName>kiss.pista</userName>
         </request>
      </ws:showUser>
   </soapenv:Body>

</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <S:Body>
      <ns2:showUserResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
         <response>
            <params/>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <user>
               <email>pista.kiss@dbx.hu</email>
               <name>Kiss Pista</name>
               <passwordChangedAt>2025-04-09T16:21:58.615Z</passwordChangedAt>
               <roles>
                  <role>doky_viewer</role>
                  <role>doky_editor</role>
                  <role>hammy_admin</role>
                  <role>doky_admin</role>
                  <role>hammy_editor</role>
                  <role>hammy_stats_viewer</role>
                  <role>hammy_viewer</role>
                  <role>hammy_edm_user</role>
                  <role>hammy_user_manager</role>
                  <role>hammy_batch_manager</role>
               </roles>
               <status>ACTIVE</status>
               <userName>gipsz.jakab</userName>
               <uuid>23</uuid>
            </user>
         </response>
      </ns2:showUserResponse>
   </S:Body>

</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/user/v2/users/{{userName}}

Válasz

Típus Leírás
JUser2 A megtalált felhasználó.

Minta

GET: hammy/json/user/v2/users/{{userName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json
ACCEPT: application/json

HTTP/1.1 200 OK
Content-Type:   application/json

{
    "meta": {
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    },
    "uuid": "23",
    "userName": "pista.kiss",
    "name": "Kiss Pista",
    "primaryOrganizationUuid": "31bc7c3f-eb41-455f-8934-23e8f1e05f3a",
    "status": "ACTIVE",
    "email": "pista.kiss@dbx.hu",
    "passwordChangedAt": "2025-04-09T16:21:58.615+00:00",
    "realmCode": "chaingun_default",
    "roles": [
        "doky_viewer",
        "doky_editor",
        "hammy_admin",
        "doky_admin",
        "hammy_editor",
        "hammy_stats_viewer",
        "hammy_user_manager",
        "hammy_viewer",
        "hammy_edm_user",
        "hammy_batch_manager"
    ],
    "organizationUuids": [
        "default",
        "31bc7c3f-eb41-455f-8934-23e8f1e05f3a",
        "8d713911-6176-4004-8079-a0c75a1b1dec"
    ]

}

Create user

Új felhasználó létrehozása.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
user User_V1 A létrehozandó felhasználó.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
user User_V1 A létrehozott felhasználó.

Minta

REST API

REST API Info

Kérés

POST hammy/json/user/v2/users

body: JUser2

Válasz

Típus Leírás
JUser2 A létrehozott felhasználó.

Minta

Modify user

Meglévő felhasználó módosítása.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
user User_V1 A módosítandó felhasználó.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
user User_V1 A módosított felhasználó.

Minta

REST API

REST API Info

Kérés

PUT hammy/json/user/v2/users

body: JUser2

Válasz

Típus Leírás
JUser2 A módosított felhasználó.

Minta

Register user

Ebben a verzióban nem változott.

Register user V1

Resend activation email

Ebben a verzióban nem változott.

Resend activation email V1

Add user to org

Ebben a verzióban nem változott.

Add user to org V1

Confirm user

Ebben a verzióban nem változott.

Confirm user V1

Reset password

Ebben a verzióban nem változott.

Reset password V1

Change password

Ebben a verzióban nem változott.

Change password V1

Authenticate

Felhasználó autentikációja.

Több szervezet

Lehetőség van több szervezethez jogosult felhasználók kezelésére is. A kérés megszokott formájában való küldéskor a szerver ellenőrzi, hogy az adott felhasználónak a csoportjai alapján milyen organizációkhoz van joga. Ha egy ilyen van, akkor minden a megszokott módon folytatódik. Abban az esetben, ha több lehetséges organizációra jogosult a felhasználó, akkor a kérés egy validációs hibával fog végződni, és a válasz paraméterei között felsorolásra kerülnek a lehetséges organizációk. Ekkor kiválasztásra kerülhet egy megfelelő organizáció, és azt egy újabb autentikációs kérés params részében be lehet küldeni (részletek lent).

Amennyiben, sikerül az authentikáció (ami azt jelenti, hogy egy megfelelő organizáció is ki lett választva), akkor a válaszban szerepelni fog a JWT token (params-ban és Authorization header-ben is). Ez a JWT token tartalmazni fogja a kiválasztott organizációt.

  • Ha több organizációra jogosult a felhasználó, akkor a válasz validációs hibával tér vissza, vagyis a responseStatus kódja 2-es értéket vesz fel és az üzenetei között szerepel egy UNSPECIFIED_ORGANIZATION_FOR_USER kódú. Emellett a válasz params mezőjében megjelenik egy paraméter GRANTED_ORGS kulccsal, aminek az értéke pedig a lehetséges organizációk listája {uuid, name} json objektum formában.
  • Az authentikációs kérés params mezőjében szükséges beküldeni egy paramétert, aminek a kulcsa USER_ORG_UUID kell, hogy legyen és értéke a választandó organizáció UUID-je.
  • A JWT tokent megtalálhatjuk a P_AUTH_TOKEN paraméterben a válaszban, vagy az Authoriztaion header-ben.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
userNameOrEmail String Felhasználónév vagy e-mail cím.
password String Jelszó.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
user User_V1 Az autentikált felhasználó.

Minta

REST API

REST API Info

Kérés

POST hammy/json/user/v2/password/authenticate

body

Név Típus Leírás
userNameOrEmail String Felhasználónév vagy e-mail cím.
password String Jelszó.

Válasz

Típus Leírás
JUser2 Az autentikált felhasználó.

Minta

Refresh auth token

Ebben a verzióban nem változott.

Refresh auth token V1

List realms

Realmek listázása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/user/v2/realms

Paraméter Típus Leírás
limit Integer A keresési találatok maximális száma.
offset Integer A találati lista kezdete.
sort String Rendezés.
clientHashKey String A hívó kliens azonosítója.
userName String A felhasználó neve.
params Param_V1 [ ] Egyéb meta adatok.

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JRealm1 [ ] A megtalált realmek.

Minta

GET /hammy/json/user/v2/realms
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

{{hammy-base}}/json/user/v2/realms

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "realms",
      "id": "chaingun_default",
      "attributes": {
        "description": "Chaingun default realm",
        "authenticatorType": "chaingun_auth_user_based",
        "passwordPolicy": "digits(2);lowerCase(2);upperCase(2);minLength(8);specialChars(1);notEmail;notUser;expirationDays(90)",
        "createdAt": "2023-05-27T22:19:26.283+00:00",
        "updatedAt": "2023-05-27T22:19:26.283+00:00"
      }
    },
    {
      "type": "realms",
      "id": "partners",
      "attributes": {
        "description": "Partners default realm",
        "authenticatorType": "chaingun_auth_user_based",
        "passwordPolicy": "digits(2);lowerCase(3);upperCase(2);minLength(8);specialChars(1);history(5);notEmail;notUser;expirationDays(365);hashAlgorithm(bcrypt)",
        "createdAt": "2023-05-28T13:53:21.936+00:00",
        "updatedAt": "2023-05-28T13:53:21.936+00:00"
      }
    },
    {
      "type": "realms",
      "id": "sample01",
      "attributes": {
        "description": "Sample",
        "passwordPolicy": "alma(10)",
        "createdAt": "2023-06-21T19:04:22.028+00:00",
        "updatedAt": "2023-06-21T19:04:22.028+00:00"
      }
    },
    {
      "type": "realms",
      "id": "sample02",
      "attributes": {
        "description": "Sample",
        "authenticatorType": "fake",
        "passwordPolicy": "alma(10)",
        "createdAt": "2023-06-21T19:59:10.254+00:00",
        "updatedAt": "2023-06-21T19:59:10.254+00:00"
      }
    },
    {
      "type": "realms",
      "id": "sample03",
      "attributes": {
        "description": "Sample 3",
        "authenticatorType": "fake",
        "passwordPolicy": "minLength(5);maxLength(10);history(5);lowerCase(1)",
        "createdAt": "2023-06-22T12:56:13.189+00:00",
        "updatedAt": "2023-06-22T12:56:13.189+00:00"
      }
    }
  ],
  "meta": {
    "total": 5,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show realm

Realm adatainak lekérése.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
code String A realm kódja.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
realm WRealm1 A megtalált realm.

Minta

REST API

REST API Info

Kérés

GET hammy/json/user/v2/realms/{{code}}

path

Név Típus Leírás
code String A realm kódja.

Válasz

Típus Leírás
JRealm1 A megtalált realm.

Minta

GET /hammy/json/user/v2/realms/{{code}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

{{hammy-base}}/json/user/v2/realms/chaingun_default

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "realms",
    "id": "chaingun_default",
    "attributes": {
      "description": "Chaingun default realm",
      "authenticatorType": "chaingun_auth_user_based",
      "passwordPolicy": "digits(2);lowerCase(2);upperCase(2);minLength(8);specialChars(1);notEmail;notUser;expirationDays(90)",
      "createdAt": "2023-05-27T22:19:26.283+00:00",
      "updatedAt": "2023-05-27T22:19:26.283+00:00"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create realm

Új realm létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/user/v2/realms

body: JRealm1

Válasz

Típus Leírás
JRealm1 A létrehozott realm.

Minta

POST /hammy/json/user/v2/realms
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "realms",
    "id": "sample03",
    "attributes": {
      "description": "Sample 3",
      "authenticatorType": "fake",
      "passwordPolicy": "minLength(5);maxLength(10);history(5);lowerCase(1)"
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "realms",
    "id": "sample03",
    "attributes": {
      "description": "Sample 3",
      "authenticatorType": "fake",
      "passwordPolicy": "minLength(5);maxLength(10);history(5);lowerCase(1)",
      "createdAt": "2023-06-22T12:56:13.189+00:00",
      "updatedAt": "2023-06-22T12:56:13.189+00:00"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Update realm

Realm módosítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

PUT hammy/json/user/v2/realms/{{code}}

body: JRealm1

Név Típus Leírás
code String A realm kódja.

Válasz

Típus Leírás
JRealm1 A módosított realm.

Minta

PUT /hammy/json/user/v2/realms/{{code}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "realms",
    "id": "sample03",
    "attributes": {
      "description": "Sample 3",
      "authenticatorType": "fake",
      "passwordPolicy": "minLength(5);maxLength(10);history(5);lowerCase(1)"
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "realms",
    "id": "sample03",
    "attributes": {
      "description": "Sample 3",
      "authenticatorType": "fake",
      "passwordPolicy": "minLength(5);maxLength(10);history(5);lowerCase(1)",
      "createdAt": "2023-06-22T12:56:13.189+00:00",
      "updatedAt": "2023-06-22T12:56:13.189+00:00"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete realm

Realm törlése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

DELETE hammy/json/user/v2/realms/{{code}}

Név Típus Leírás
code String A realm kódja.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta