Richemont.Booster2.PublicApi

<back to all web services

CreateUserAuth

Requires Authentication
The following routes are available for this service:
POST/user/{brand}/{userId}/authorizeCreate the authorization for the given external user and for the given POS CodesThe 'CreateUserAuth' API is not implemented for internal users
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CreateUserAuthResponse implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

class AuthRequest implements JsonSerializable
{
    public function __construct(
        /** @description POS Code (only for external users) */
        // @ApiMember(Description="POS Code (only for external users)", IsRequired=true)
        /** @var string */
        public string $posCode='',

        /** @description Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
        // @ApiMember(Description="Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
        /** @var array<string>|null */
        public ?array $roles=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['posCode'])) $this->posCode = $o['posCode'];
        if (isset($o['roles'])) $this->roles = JsonConverters::fromArray('Guid', $o['roles']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->posCode)) $o['posCode'] = $this->posCode;
        if (isset($this->roles)) $o['roles'] = JsonConverters::toArray('Guid', $this->roles);
        return empty($o) ? new class(){} : $o;
    }
}

class CreateUserAuth implements JsonSerializable
{
    public function __construct(
        /** @description User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
        // @ApiMember(Description="User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
        /** @var string */
        public string $userId='',

        /** @description Brand Trigram, e.g. CAR, IWC, VAC */
        // @ApiMember(Description="Brand Trigram, e.g. CAR, IWC, VAC", IsRequired=true)
        /** @var string */
        public string $brand='',

        /** @description Authorization requests for the provided user */
        // @ApiMember(Description="Authorization requests for the provided user", IsRequired=true)
        /** @var array<AuthRequest>|null */
        public ?array $authRequests=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['brand'])) $this->brand = $o['brand'];
        if (isset($o['authRequests'])) $this->authRequests = JsonConverters::fromArray('AuthRequest', $o['authRequests']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->brand)) $o['brand'] = $this->brand;
        if (isset($this->authRequests)) $o['authRequests'] = JsonConverters::toArray('AuthRequest', $this->authRequests);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateUserAuth DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /user/{brand}/{userId}/authorize HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userId":"String","brand":"String","authRequests":[{"posCode":"String","roles":["00000000000000000000000000000000"]}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}