• Document Up to Date

Get Profiles By Role

Returns a list of profiles for a specific role and tenant.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /crafter-profile, please prefix the API URLs with this context.

HTTP Verb
GET
URL
/api/1/profile/by_role
Response Formats
JSON

Parameters

Name
Type
Required
Description
accessTokenId

String


The access token ID of the application
making the call
tenantName
String
The tenant’s name
role
String
The role’s name
sortBy
String

Profile attribute to sort the list by
sortOrder
String

The sort order (either ASC or DESC)
attributesToReturn

String



The name of the attributes to return
(don’t specify to return all)

Example

Request

GET .../api/1/profile/by_role?accessTokenId=e8f5170c-877b-416f-b70f-4b09772f8e2d&tenantName=sample-tenant&role=APP_TEST

Response

Status 200 OK

 1[
 2  {
 3    "username": "john.doe",
 4    "email": "john.doe@example.com",
 5    "verified": false,
 6    "enabled": false,
 7    "createdOn": 1495811673842,
 8    "lastModified": 1495812397986,
 9    "tenant": "sample-tenant",
10    "roles": [
11      "APP_TEST",
12      "APP_REPORT"
13    ],
14    "attributes": {},
15    "id": "59284659d4c650213cc2f3fc"
16  }
17]

Responses

Status
Location
Response Body
200

See example above.
500

{ "message" : "Internal server error" }