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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreateUserAuth
    {
        /**
        * 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)
        public String userId = null;

        /**
        * Brand Trigram, e.g. CAR, IWC, VAC
        */
        @ApiMember(Description="Brand Trigram, e.g. CAR, IWC, VAC", IsRequired=true)
        public String brand = null;

        /**
        * Authorization requests for the provided user
        */
        @ApiMember(Description="Authorization requests for the provided user", IsRequired=true)
        public ArrayList<AuthRequest> authRequests = null;
        
        public String getUserId() { return userId; }
        public CreateUserAuth setUserId(String value) { this.userId = value; return this; }
        public String getBrand() { return brand; }
        public CreateUserAuth setBrand(String value) { this.brand = value; return this; }
        public ArrayList<AuthRequest> getAuthRequests() { return authRequests; }
        public CreateUserAuth setAuthRequests(ArrayList<AuthRequest> value) { this.authRequests = value; return this; }
    }

    public static class AuthRequest
    {
        /**
        * POS Code (only for external users)
        */
        @ApiMember(Description="POS Code (only for external users)", IsRequired=true)
        public String posCode = null;

        /**
        * 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)
        public ArrayList<UUID> roles = null;
        
        public String getPosCode() { return posCode; }
        public AuthRequest setPosCode(String value) { this.posCode = value; return this; }
        public ArrayList<UUID> getRoles() { return roles; }
        public AuthRequest setRoles(ArrayList<UUID> value) { this.roles = value; return this; }
    }

    public static class CreateUserAuthResponse
    {
        
    }

}

Java CreateUserAuth DTOs

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

HTTP + XML

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

<CreateUserAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <authRequests>
    <AuthRequest>
      <posCode>String</posCode>
      <roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </roles>
    </AuthRequest>
  </authRequests>
  <brand>String</brand>
  <userId>String</userId>
</CreateUserAuth>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateUserAuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel" />