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
"use strict";
export class CreateUserAuthResponse {
    constructor(init) { Object.assign(this, init) }
}
export class AuthRequest {
    /** @param {{posCode?:string,roles?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description POS Code (only for external users) */
    posCode;
    /**
     * @type {string[]}
     * @description Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
    roles;
}
export class CreateUserAuth {
    /** @param {{userId?:string,brand?:string,authRequests?:AuthRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
    userId;
    /**
     * @type {string}
     * @description Brand Trigram, e.g. CAR, IWC, VAC */
    brand;
    /**
     * @type {AuthRequest[]}
     * @description Authorization requests for the provided user */
    authRequests;
}

JavaScript 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" />