Skip to main content

TempAccessCodesApi

MethodHTTP requestDescription
CreateTempAccessCodeUsingPOSTPOST /api/web/v1/users/{userid}/tempaccesscodeCreate a temporary access code
DeleteTempAccessCodeUsingDELETEDELETE /api/web/v1/users/{userid}/tempaccesscodeDelete a temporary access code
GetTempAccessCodeUsingGETGET /api/web/v1/users/{userid}/tempaccesscodeGet a temporary access code

CreateTempAccessCodeUsingPOST

TempAccessCode CreateTempAccessCodeUsingPOST (string userid)

Create a temporary access code

Create a temporary access code for the given user. Caller requires the TEMPACCESSCODE:ADD permission.

Using the CreateTempAccessCodeUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user for which a temporary access code will be created.

Return type

TempAccessCode

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

DeleteTempAccessCodeUsingDELETE

void DeleteTempAccessCodeUsingDELETE (string userid)

Delete a temporary access code

Delete the temporary access code for the given user. Caller requires the TEMPACCESSCODE:REMOVE permission.

Example

Using the DeleteTempAccessCodeUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user whose temporary access code will be deleted.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

GetTempAccessCodeUsingGET

TempAccessCode GetTempAccessCodeUsingGET (string userid)

Get a temporary access code

Get the temporary access code for the given user. Caller requires the TEMPACCESSCODE:VIEW permission.

Example

Using the GetTempAccessCodeUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user whose temporary access code will be fetched.

Return type

TempAccessCode

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-