Get Do Device Register

Get Do Device Register

This endpoint is the starting point of a mobile device dynamic client registration flow.

Request
URI
GET
https://{api_host}//SAAS/auth/device/register
COPY
Query Parameters
string
app_product_id
Required

Specifies the name of the template that was registered with VMware Identity Manager.

app_product_id example
VMware-AppAuth-Samples-Template
string
user_device
Required

A JSON representation of a user's device. It contains device information.

user_device example
%7B%22osFamily%22%3A%22Android%22%2C%22extendedAttributeMap%22%3A%7B%22model%22%3A%22Android+SDK+built+for+x86%22%7D%2C%22machineName%22%3A%22unknown%22%2C%22osVersion%22%3A24%2C%22osName%22%3A%22Android%22%2C%22deviceId%22%3A%227ea00d46-35eb-4cd9-951a-4b790c14bb4f%22%7D
string
device_name
Required

A unique identifier for the user's device.

device_name example
my+Android+123456
string
response_type
Required

Must be 'code'.

response_type example
code
string
redirect_uri
Required

Specifies the callback endpoint in your application that will receive the authorization code. It must match the redirect_uri defined in the pre-created template in VMware Identity Manager. When sending the redirect_uri as a URL parameter it has to be URL encoded.

redirect_uri example
com.vmware.idm.samples.mobilesso%3A%2F%2Foauth2redirect
string
state
Optional

A random string that your application generates and that will be sent back as a parameter during the URI redirection.

state example
5aPY-C1JSeyTiUPWV_DLDw
string
scope
Optional

The list of scopes of the authorization request separated by space and is URL encoded. The scopes must be equivalent or a subset of the scopes defined in the template.

scope example
openid+profile+email+user

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Operation doesn't return any data structure

302

VMware Identity Manager will redirect to the specified redirect_uri. The redirect URL will contain 'error' and 'error_description' query parameters if there is an error: the response_type is invalid or missing, the specified scope is unknown. Otherwise the redirect URL will contain the state, the activation code and the authorization code to exchange respectively in the activation and authorization subsequent requests.

Operation doesn't return any data structure

400

The error can be any of those: the app_product_id does not exist, the user_device is not specified or incorrect, the redirect_uri is not specified or invalid or does not match the one in the app_product_id.

Operation doesn't return any data structure