Skip to main content

MachineAuthApi

MethodHTTP requestDescription
CreateMachineAuthenticatorUsingPOSTPOST /api/web/v1/users/{userid}/machinesCreate a Machine Authenticator
DeleteMachineAuthenticatorUsingDELETEDELETE /api/web/v1/users/{userid}/machines/{id}Delete a Machine Authenticator
ListMachineAuthenticatorsUsingGETGET /api/web/v1/users/{userid}/machinesList machine authenticators for a user

CreateMachineAuthenticatorUsingPOST

MachineAuthenticatorRegistrationResult CreateMachineAuthenticatorUsingPOST (string userid, MachineAuthenticatorRegistration machineAuthenticatorRegistration)

Create a Machine Authenticator

Create a Machine Authenticator for a user. Caller requires the USERMACHINES:ADD permission.

Using the CreateMachineAuthenticatorUsingPOSTWithHttpInfo variant

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

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user for which the machine authenticator is to be added.
machineAuthenticatorRegistrationMachineAuthenticatorRegistration

Return type

MachineAuthenticatorRegistrationResult

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

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

DeleteMachineAuthenticatorUsingDELETE

void DeleteMachineAuthenticatorUsingDELETE (string userid, string id)

Delete a Machine Authenticator

Deletes a Machine Authenticator from a user. Caller requires the USERMACHINES:REMOVE permission.

Example

Using the DeleteMachineAuthenticatorUsingDELETEWithHttpInfo variant

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

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user from which the machine authenticator is to be deleted.
idstringThe UUID of the machine authenticator which is to 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-

ListMachineAuthenticatorsUsingGET

List<UserMachineAuthenticator> ListMachineAuthenticatorsUsingGET (string userid)

List machine authenticators for a user

List all machine authenticators for the specified user. Caller requires the USERMACHINES:VIEW permission.

Example

Using the ListMachineAuthenticatorsUsingGETWithHttpInfo variant

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

Parameters

NameTypeDescriptionNotes
useridstringThe UUID of the user for which machine authenticators are to be fetched.

Return type

List<UserMachineAuthenticator>

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-