GET /apps/:appId/user-roles

Request

This route will return all user roles of an app.

Request Method:

• GET

Base URL:

• https://api.userdocks.com

End Point:

• /v1/apps/:appId/user-roles

Path Variables:

Variable	Type	Required	Description
:appId	String	true	the UUID of the app

Query Parameters:

None

HTTP Headers:

Note: Never use API Keys on the client

Note: This endpoint can only be accessed with an API key

Property	Type	Required	Access	Description
X-API-KEY	String	true	Only access to App	Api key for the userdocks app
X-API-KEY-TYPE	String	true	Only access to App	read or write
X-CLIENT-ID	String	true	Only access to App	UUID of the userdocks app

HTTP Body:

None

Response:

• Object

Example:

try {
  // call userdocks user management API
  const response = await fetch('https://api.userdocks.com/v1/apps/:appId/user-roles', {
    method: 'GET',
    headers: {
      // an access token can also be used
      // Authorization: `${token.type} ${token.accessToken}`,
      'X-API-KEY': String,
      'X-CLIENT-ID': String,
      'X-API-KEY-TYPE': 'read',
      'Content-Type': 'application/json',
    },
  });
  const { data } = await response.json();

  // do something with the data
} catch (err) {
  console.error(err);
  // handle error
}

Successful Response:

Can have the following HTTP Status Codes:

• 200 - OK

// GET /v1/apps/:appId/user-roles
{
  "success": Boolean,
  "message": String,
  "error": null,
  "data": {
    "kind": "userRole",
    "itemsLength": Number,
    "items":[
      {
        id: String,
        name: String,
      },
    ],
  },
}

Error Response:

Can have the following HTTP Status Codes:

• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 500 - Internal Server Error

// GET /v1/apps/:appId/user-roles
{
  "success": Boolean,
  "error": String,
  "message": null,
  "data": null
}