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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateUserAuthResponse:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthRequest:
    # @ApiMember(Description="POS Code (only for external users)", IsRequired=true)
    pos_code: Optional[str] = None
    """
    POS Code (only for external users)
    """


    # @ApiMember(Description="Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
    roles: Optional[List[str]] = None
    """
    Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateUserAuth:
    # @ApiMember(Description="User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
    user_id: Optional[str] = None
    """
    User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'
    """


    # @ApiMember(Description="Brand Trigram, e.g. CAR, IWC, VAC", IsRequired=true)
    brand: Optional[str] = None
    """
    Brand Trigram, e.g. CAR, IWC, VAC
    """


    # @ApiMember(Description="Authorization requests for the provided user", IsRequired=true)
    auth_requests: Optional[List[AuthRequest]] = None
    """
    Authorization requests for the provided user
    """

Python CreateUserAuth DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

{}