Get Single User

GET /users/{userName}

Bearer auth

This API call is used to get information for a single user with the given username or id.

Path parameters

userName string Required

Username or ID of the user.

Query parameters

include string

Include additional information for the user.

Values are lastlogin or activities.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- id string
  
  The unique identifier of the user.
- userName string
  
  The username of the user.
- name object
  
  Hide name attributes Show name attributes object
  
  firstName string
  
  The first name of the user.
  
  middleName string
  
  The middle name of the user.
  
  lastName string
  
  The last name of the user.
  
  displayName string
  
  The display name of the user.
- email string
- phoneNumber string
- roles array[object]
  
  One of:
  object-1 object object-2 object object-3 object
- userAccess object
  
  Hide userAccess attributes Show userAccess attributes object
  
  r2RReadOnly boolean
  
  Specifies whether the user has read only access to R2R Console.
  
  r2RAdmin boolean
  
  Specifies whether the user has admin access to R2R Console.
  
  r2rEnabled boolean
  
  Specifies whether the user has access to R2R Console.
  
  accessAutomation boolean
  
  Specifies whether the user has access to Smart Automation.
  
  accessCertification boolean
  
  Specifies whether the user has access to Certification.
  
  accessClose boolean
  
  Specifies whether the user has access to Close.
  
  accessCompliance boolean
  
  Specifies whether the user has access to Compliance.
  
  accessComplete boolean
  
  Specifies whether the user has access to Complete.
  
  accessOperationalMatching boolean
  
  Specifies whether the user has access to Match.
- departmentId string
  
  The department code value.
- locationId string
  
  The location code value.
- programAdminRoleId string
  
  The program admin role.
- match object
  
  Hide match attributes Show match attributes object
  
  securityProfileId integer
  
  The security profile id.
  
  disabled boolean
  
  Indicates if Match permission is disabled.
  
  accessAllAccounts boolean
  
  Indicates if user has access to all accounts.
  
  accessAllSectors boolean
  
  Indicates if user has access to all sectors.
  
  operationalStructureIds array[integer]
  
  List of operational structure ids assigned to user.
  
  sectorIds array[integer]
  
  List of sector ids assigned to user.
- createdDate string
  
  The date and time when user was created.
- active boolean
  
  Indicates whether the user is active or inactive.
- lockedOut boolean
  
  Indicates whether the user is currently locked out from accessing the system.
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.
404 application/json

User Not Found
Hide response attributes Show response attributes object
- status integer
- error string

GET /users/{userName}

curl \
 --request GET 'https://localhost:8080/users/testuser1' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "f1666d0e-b1ff-4367-b678-ca711623715c",
  "name": {
    "lastName": "User",
    "firstName": "Test",
    "middleName": "A",
    "displayName": "Test User1"
  },
  "email": "testuser1@localhost.local",
  "roles": [
    {
      "type": "Close",
      "value": "CloseAdmin"
    },
    {
      "type": "Certification",
      "value": "Reconciler"
    },
    {
      "type": "JournalEntry",
      "value": "Preparer"
    }
  ],
  "active": true,
  "userName": "testuser1",
  "lockedOut": false,
  "locationId": "Americas",
  "userAccess": {
    "r2RAdmin": false,
    "r2REnabled": true,
    "accessClose": true,
    "r2RReadOnly": true,
    "accessComplete": false,
    "accessAutomation": true,
    "accessCompliance": true,
    "accessCertification": true,
    "accessOperationalMatching": false
  },
  "createdDate": "2023-06-20T18:22:57Z",
  "phoneNumber": "555-555-5555",
  "departmentId": "SALES",
  "programAdminRoleId": "Admin"
}

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}

Response examples (404)

{
  "error": "User not found for specified id or username.",
  "status": 404
}