User API V1

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

REST API

REST API Info

Kérés

GET hammy/user/v1/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	JUser_V1 [ ]	A megtalált felhasználók.

Minta

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

KérésVálasz

<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>
                <userName>belépett user neve, nem összekeverendő a a lekérni kívánt user nevével</userName>
                </requestMeta>
                <userName>mokamiki</userName>
            </request>
        </ws:showUser>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:showUserResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@dbx.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                <roles>majomidomar</roles>
                <roles>csokidealer</roles>
                <status>ACTIVE</status>
                <userName>mokamiki</userName>
                </user>
            </response>
        </ns2:showUserResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

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

Válasz

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

Minta

KérésVálasz

GET /hammy/json/user/v1/users/{{userName}}?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
    "data": {
        "type": "users",
        "id": "{{userName}}",
        "attributes": {
            "name": "Móka Miklós",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "status": "ACTIVE",
            "email": "moka.miklos@dbx.hu",
            "roles": [
                "majomidomar",
                "csokidealer"
            ]
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

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

KérésVálasz

<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:createUser>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>belépett user neve, nem összekeverendő a user alatti userName-el</userName>
                </requestMeta>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@zsebtv.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                <passwordResetGuidChannel>RESPONSE</passwordResetGuidChannel>
                <roles>
                        <role>majomidomar</role>               
                        <role>lovas</role>  
                </roles>
                <userName>mokamiki</userName>
                </user>
            </request>
        </ws:createUser>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createUserResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@zsebtv.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                <status>UNACTIVATED</status>
                <userName>mokamiki</userName>
                </user>
            </response>
        </ns2:createUserResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/user/v1/users

body: JUser_V1

Válasz

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

Minta

KérésVálasz

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

{
    "data": {
        "type": "users",
        "id": "egyedi id, modifyUser esetén ugyanezt kell küldeni. Create esetén nem kötelező, ha üres, a backend generálja",
        "attributes": {
            "name": "Hakapeszi Maki",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "email": "hakapeszi.maki@dbx.hu",
            "roles": ["csokidealer"]
        }
    }
}

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

{
    "data": {
        "type": "users",
        "id": "egyedi id, modifyUser esetén ugyanezt kell küldeni",
        "attributes": {
            "name": "Hakapeszi Maki",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "status": "UNACTIVATED",
            "email": "hakapeszi.maki@dbx.hu",
            "roles": ["csokidealer"]
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

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

KérésVálasz

<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:modifyUser>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>belépett user neve, nem összekeverendő a user alatti userName-el</userName>
                </requestMeta>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@dbx.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                <status>ACTIVE</status>
                <userName>mokamiki</userName>               
                <roles>
                    <role>majomidomar</role>
                </roles>
                </user>
            </request>
        </ws:modifyUser>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:modifyUserResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@dbx.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                    <roles>
                    <role>majomidomar</role>
                    <role>csokidealer</role>
                </roles>
                <status>ACTIVE</status>
                <userName>mokamiki</userName>
                </user>
            </response>
        </ns2:modifyUserResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/user/v1/users

body: JUser_V1

Válasz

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

Minta

KérésVálasz

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

{
    "data": {
        "type": "users",
        "id": "egyedi id, a createUser válaszában lévő id-val meg kell egyezzen",
        "attributes": {
            "name": "Hakapeszi Maki",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "status": "ACTIVE",
            "email": "hakapeszi.maki@dbx.hu",
            "roles": ["csokifogyaszto"]
        }
    }
}

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

{
    "data": {
        "type": "users",
        "id": "egyedi id, a createUser válaszában lévő id-val meg kell egyezzen",
        "attributes": {
            "name": "Hakapeszi Maki",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "status": "ACTIVE",
            "email": "hakapeszi.maki@dbx.hu",
            "roles": [
                "csokifogyaszto"
            ]
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Register user

Új felhasználó regisztrálása.

Web service API

Kérés

Név	Típus	Leírás
username	String	Felhasználónév.
password	String	Felhasználó jelszava.
name	String	Felhasználó neve.
email	String	Felhasználó email címe.
organizationUuid	String	Szervezet azonosítója.

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.

Minta

KérésVálasz

<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:registerUser>
            <request>
                <username>valaki</username>
                <password>ValaKi1234</password>
                <name>Valaki</name>
                <email>valaki@valami.hu</email>
            </request>
        </ws:registerUser>
    </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:registerUserResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
            </response>
        </ns2:registerUserResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/user/v1/register

body

Név	Típus	Leírás
username	String	Felhasználónév.
password	String	Felhasználó jelszava.
name	String	Felhasználó neve.
email	String	Felhasználó email címe.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/register
Content-Type: application/json

{
    "username": "tesztuser",
    "name": "Teszt User",
    "email": "teszt@teszt.hu",
    "password": "TeszT1234"
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "76ea8fb5-2f71-4793-9731-cf666bfff6f9",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Resend activation email

Megerősítő email újraküldé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

POST hammy/json/user/v1/register/resend

body

Név	Típus	Leírás
usernameOrEmail	String	Felhasználónév vagy email cím.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/register/resend
Content-Type: application/json

{
    "usernameOrEmail": "tesztuser"
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "76ea8fb5-2f71-4793-9731-cf666bfff6f9",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Add user to org

Felhasználó hozzárendelése egy szervezethez.

Ha egy szervezet UUID azonosítóját adjuk meg akkor egy létező szervezethez szeretnénk rendelni a felhasználót, viszont ha UUID azonosítót nem adunk meg csak nevet, akkor egy új szervezetet fogunk létrehozni azon a néven.
Ha meg van adva UUID akkor nem kell nevet is megadni.
A válaszban visszakapunk egy új JWT tokent, ami tartalmazza a szervezetet és a felhasználó jogait.

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/v1/register/addToOrg

body

Név	Típus	Leírás
orgName	String	Szervezet neve.
orgUuid	String	Szervezet UUID azonosítója.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/register/addToOrg
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "orgUuid": "8ffd45df-923f-485a-8e1e-a2c7bff674e3"
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "0864c1f3-a646-41d5-b7a0-b60cbbacb9fb",
        "attributes": {}
    },
    "meta": {
        "params": [
            {
                "key": "P_AUTH_TOKEN",
                "value": "JWT {{JWT_TOKEN}}"
            }
        ],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Confirm user

Felhasználó megerősíté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

POST hammy/json/user/v1/register/confirm

body

Név	Típus	Leírás
token	String	Megerősítő token.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/register/confirm
Content-Type: application/json

{
    "token": "fc375d646f284b17bf98e4ee7fdb6975"
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "76ea8fb5-2f71-4793-9731-cf666bfff6f9",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Reset password

Jelszó változtatási kérelem bejelentése.

A hívás után a felhasználó egy e-mailt fog kapni, amiben egy tokent tartalmazó link van jelszóváltoztatási oldalra.

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 email cím.

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.

Minta

KérésVálasz

<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:resetPassword>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>belépett user neve, nem összekeverendő a user alatti userName-el</userName>
                </requestMeta>
                <userNameOrEmail>mokamiki</userNameOrEmail>
            </request>
        </ws:resetPassword>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:resetPasswordResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
            </response>
        </ns2:resetPasswordResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/user/v1/password/reset

body

Név	Típus	Leírás
usernameOrEmail	String	Felhasználónév vagy email cím. (vnd.api ID)

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/password/reset
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "resetPasswordRequest",
        "id": "userName or email address",
        "attributes": {
        }
    }
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "f6cdd3ee-9ba5-423b-9454-104ba7614d9c",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Change password

Jelszó változtatás. A kapott emailben szereplő linkből lehet kinyerni a token-t. oldPassword - password párossal, vagy passwordResetGuid - password párossal lehet jelszót változtatni, a kapcsolat kizáró vagy. Amennyiben passwordResetGuid érték meg lett adva, a userName megadása nem kötelező.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
passwordResetGuid	String	Jelszó változtatási token.
password	String	A beállítandó jelszó.
oldPassword	String	Régi jelszó.
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.

Minta

KérésVálasz

<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:changePassword>
            <request>
                <!-- <oldPassword></oldPassword> -->
                <password>{{password}}</password>
                <passwordResetGuid>{{passwordResetGuid}}</passwordResetGuid>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>belépett user neve, nem összekeverendő a user alatti userName-el</userName>             
                </requestMeta>
                <!-- <userName></userName>-->
            </request>
        </ws:changePassword>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:changePasswordResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
            </response>
        </ns2:changePasswordResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/user/v1/password/change

body

Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
userName	String	Felhasználó név.
oldPassword	String	Régi jelszó.
password	String	A beállítandó jelszó.
passwordResetGuid	String	Jelszó változtatási token.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/user/v1/password/change
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "changePasswordRequest",
        "id": "tetszoleges random, szerepe nincs",
        "attributes": {
          "passwordResetGuid" : "{{passwordResetGuid}}",
          "password" : "{{password}}"
        }
    }
}

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

{
    "data": {
        "type": "emptyResponse",
        "id": "b7c2ae32-d7a9-48fe-aab1-2b00d38524bc",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

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

KérésVálasz

<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:authenticate>
            <request>
                <password>{{password}}</password>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>belépett user neve, nem összekeverendő a user alatti userName-el</userName>
                </requestMeta>
                <userNameOrEmail>mokamiki</userNameOrEmail>
            </request>
        </ws:authenticate>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:authenticateResponse xmlns:ns2="http://ws.service.user.api.chaingun.dbx.hu/">
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <user>
                <clientName>Default</clientName>
                <email>moka.miklos@dbx.hu</email>
                <name>Móka Miklós</name>
                <organizationalUnit>zsebtv</organizationalUnit>
                <roles>majomidomar</roles>
                <roles>csokidealer</roles>
                <status>ACTIVE</status>
                <userName>mokamiki</userName>
                </user>
            </response>
        </ns2:authenticateResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/user/v1/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
JUser_V1	Az autentikált felhasználó.

Minta

KérésKérés (választott org)VálaszVálasz (választható szervezettekkel)Dekódolt JWT body szervezettel

POST /hammy/json/user/v1/password/authenticate
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "authenticateRequest",
        "id": "hakapeszimaki",
        "attributes": {
          "password" : "passWORD123"
        }
    }
}

POST /hammy/json/user/v1/password/authenticate
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "authenticateRequest",
        "id": "hakapeszimaki",
        "attributes": {
          "password" : "passWORD123"
        }
    },
    "meta": {
        "params": [
            {
                "key": "USER_ORG_UUID",
                "value": "hammy"
            }
        ]
    }
}

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

{
    "data": {
        "type": "user",
        "id": "hakapeszimaki",
        "attributes": {
            "name": "Hakapeszi Maki",
            "clientName": "Default",
            "organizationalUnit": "zsebtv",
            "status": "ACTIVE",
            "email": "gabor.papp+hakapeszi.maki@dbx.hu",
            "roles": [
                "csokifogyaszto"
            ]
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "users",
        "attributes": {
            "roles": []
        }
    },
    "meta": {
        "params": [
            {
                "key": "GRANTED_ORGS",
                "value": "[{\"uuid\":\"default\",\"name\":\"Default Org\"},{\"uuid\":\"hammy\",\"name\":\"Hammy Organization\"},{\"uuid\":\"moby\",\"name\":\"Moby Organization\"}]"
            }
        ],
        "responseStatus": {
            "code": 2,
            "messages": [
                {
                    "severity": "ERROR",
                    "code": "UNSPECIFIED_ORGANIZATION_FOR_USER",
                    "description": "Kötelező megadni, hogy a felhasználó melyik organizációhoz legyen kötve, ha az nem egyértelmű!"
                }
            ]
        }
    }
}

{
    "sub": "admin",
    "exp": 1601975689,
    "nbf": 1601973889,
    "iat": 1601973889,
    "jti": "7851781a-9338-454e-84bc-4694f7e62957",
    "rls": [],
    "org": {
      "uuid": "hammy",
      "name": "Hammy Organization"
    }
}

Refresh auth token

Autentikációs token frissíté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

POST hammy/json/user/v1/password/refreshAuthToken

body

Név	Típus	Leírás
authorization	String	Authorizáció fajtája.

Válasz

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