topic Re: QRS API : Allocate license access in Integration, Extension & APIs

QRS API : Allocate license access

jeff007 — Sat, 16 Nov 2024 05:55:41 GMT

Hi,

I would like to allocate analyzer (or profesional) access with the QRS API.

I am trying to do it according to that documentation https://help.qlik.com/en-US/sense-developer/February2019/APIs/repositoryserviceapi/index.html?page=1207

(which unfortunately does not contains an example of the request body to send)

I am sending a POST request to https://my-qlik-server:4242/qrs/license/analyzeraccesstype?Xrfkey=xbZdef9hijkPxn4P

Body :

{
"modifiedByUserName": "INTERNAL\\sa_repository",
"modifiedDate": "2019-05-03T17:23:02.316Z",
"user": {
"userDirectory": "AZ-XXX",
"userId": "2db75108-922f-4736-8461-a7ec7c1edda2"
},
"createdDate": "2019-05-03T17:23:02.315Z"
}

But, in return, I get a HTTP 400 (bad request)

Could you please provide the body that must be passed to make it work ?

Is there any logs in QlikSense giving more details about what is bad in the request ?

Thanks,

PS : I have other QRS APIs calls working fine, the problem is specific to that API. Certificate authentication is OK and HTTP headers like Xrfkey are passed correctly...

Re: QRS API : Allocate license access

Levi_Turner — Tue, 21 May 2019 13:03:29 GMT

On my end, I am able to do it using this:

Endpoint: POST /qrs/license/analyzeraccesstype
Body: {"user": {"id": "9309c057-97c3-4f42-8e86-65b170675c32"}}
- Where the ID refers to the UserID

From your end, you shouldn't need the modifiedByUserName, modifiedDate, or createdDate elements since the entity doesn't exist yet. The QRS will add those as needed.

Re: QRS API : Allocate license access

jeff007 — Tue, 21 May 2019 13:19:35 GMT

Hi Levi,

Thanks for your support, unfortunately I still have the same HTTP 400 as a response (I probably already tested that body before)

But it's already a good thing to know that this request is working on your end !

Do you know if there is any log files on Qlik Sense that could help ?

Thanks

Re: QRS API : Allocate license access

Levi_Turner — Tue, 21 May 2019 13:39:30 GMT

I am not seeing an obvious one. What is the actual response? For example on my end "errorText": "Violation of the uniqueness constraint" comes when I try to allocate a user an Analyzer pass when they already have one.

Re: QRS API : Allocate license access

jeff007 — Tue, 21 May 2019 13:49:38 GMT

Thanks, I had not thought to read the body of the message when when the HTTP response code was not normal ...

Now I can better understand !

Have a good day !

Re: QRS API : Allocate license access

rytisgasparavic — Fri, 20 Dec 2019 11:38:07 GMT

Hi Jeff,

Were you able to solve "HTTP 400 (bad request)" exception?

I am getting the same error.

Thanks

Rytis

Re: QRS API : Allocate license access

jeff007 — Fri, 20 Dec 2019 13:29:28 GMT

Hi Rytis,

Yes, I could find more details when looking at the body of the HTTP response.

I think it was because the user already had a license.

Regards,

Jeff

Re: QRS API : Allocate license access

rytisgasparavic — Mon, 30 Dec 2019 09:33:31 GMT

Thanks Jeff,

Understood, I am seeing a detailed error in response as well now.

Regards,

Rytis

Re: QRS API : Allocate license access

MostafaFares55 — Tue, 12 Apr 2022 20:58:53 GMT

Dears,

When I try to use QRS-API to give an analyzer access to a user

post /license/analyzeraccesstype

* I am testing with a virtual proxy - header authentication static user directory in QMC.

It shows "No matching endpoint found"

I use Open API specification for Repository Main API

Please, help. @Levi_Turner

Re: QRS API : Allocate license access

MostafaFares55 — Wed, 13 Apr 2022 12:22:18 GMT

It worked when I gave an admin role (repository access) to my api user.

Re: QRS API : Allocate license access

makunii — Fri, 10 Mar 2023 19:25:57 GMT

Script Powershell:

$hdrs = @{}
$hdrs.Add("X-Qlik-xrfkey","12345678qwertyui")
$hdrs.Add("X-Qlik-User","UserDirectory=xxxx;UserId=xxxxx")
$hdrs.Add("Content-Type","application/json")
$cert = Get-ChildItem -Path "Cert:\CurrentUser\My" | Where {$_.Subject -like '*QlikClient*'}
$body = '{"user":{"id":"244ee0d3-7ee1-42bc-b3ac-f30787dd6d3b"}}'
$url2 = "https://<sense server>:4242/qrs/license/professionalaccesstype?xrfkey=12345678qwertyui"
Invoke-RestMethod -Uri $url2 -Method Post -Headers $hdrs -Certificate $cert -Body $body

Analyzer licenses, replace "professionalaccesstype" to "analyzeraccesstype"

Re: QRS API : Allocate license access

Marc — Tue, 14 Mar 2023 23:20:50 GMT

if you use the PowerShell Module QlikSenseCLI you can easily extend this

by setting the UserID & UserDirectory values the following script will look for the user in Qlik Sense, if the User does not exist it will be create and then you can assign the license. (that way you don't need to know their GUID id)

#Get the QlikClient Certificate $cert = Get-ChildItem -Path "Cert:\CurrentUser\My" | Where-Object { $_.Subject -eq 'CN=QlikClient' } | Sort-Object -Property NotAfter | Select-Object -First 1 #Connect to Qlik Sense QRS Connect-QlikSense -Certificate $cert -Username "Internal\sa_api" $UserID = 'QlikMarc' $UserDirectory = $env:USERDOMAIN #Get the User (-Filter Always returns an array) $user = Get-QSUser -Filter "userid eq '$($UserID)' and userdirectory eq '$($UserDirectory)'" #If there is no user found create the user if ($user.Count -eq 0) { $Null = Add-QSUser -UserObj $(New-QSUser -UserId $UserID -UserDirectory $UserDirectory); $user = Get-QSUser -Filter "userid eq '$($UserID)'" } #then assign a license #Analyzer $AAccessType = $user | ForEach-Object{ New-QSLicenseAnalyzerAccessType -User $_ } Add-QSLicenseAnalyzeraccesstype -Many -LicenseAnalyzerAccessTypeObjs $AAccessType #Professional $PAccessType = $user | ForEach-Object{ New-QSLicenseProfessionalAccessType -User $_ } Add-QSLicenseProfessionalaccesstype -Many -LicenseProfessionalAccessTypeObjs $PAccessType

Alternatively you can set it to Assign a professional license only if the user exists and does not already have a license of the type assigned

#https://github.com/QlikProfessionalServices/QlikSenseCLI $cert = Get-ChildItem -Path "Cert:\CurrentUser\My" | Where-Object { $_.Subject -eq 'CN=QlikClient' } | Sort-Object -Property NotAfter -Descending | Select-Object -First 1 Connect-QlikSense -Certificate $cert -Username "Internal\sa_api" $UserID = 'QlikMarc' $UserDirectory = $env:USERDOMAIN $user = Get-QSUser -Filter "userid eq '$($UserID)' and userdirectory eq '$($UserDirectory)'" if ($user.Count -gt 0) { $user | ForEach-Object{ $existing = Get-QSLicenseProfessionalaccesstype -Filter "user.userid eq '$($UserID)' and user.userdirectory eq '$($UserDirectory)'" if ($existing.Count -eq 0) { $PAccessType = $user | ForEach-Object{ New-QSLicenseProfessionalAccessType -User $_ } Add-QSLicenseProfessionalaccesstype -Many -LicenseProfessionalAccessTypeObjs $PAccessType } } }