Get users with project access

GET 
/v2/projects/:projectId/users

Returns all project users, who have permission to access project

Request

Path Parameters

projectId int64required

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

search string

Responses

200

OK

application/json

Schema

Schema

_embedded object
users object[]
Array [
id int64required
username stringrequired
name string
avatar object
large stringrequired
thumbnail stringrequired
organizationRole string
Possible values: [MEMBER, OWNER]
organizationBasePermission objectrequired
Current user's direct permission
scopes string[]required
Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]
Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.
type string
Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]
The user's permission type. This field is null if uses granular permissions
permittedLanguageIds int64[]deprecated
Deprecated (use translateLanguageIds).
List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.
translateLanguageIds int64[]
List of languages user can translate to. If null, all languages editing is permitted.
viewLanguageIds int64[]
List of languages user can view. If null, all languages view is permitted.
stateChangeLanguageIds int64[]
List of languages user can change state to. If null, changing state of all language values is permitted.
directPermission object
Current user's direct permission
scopes string[]required
Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]
Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.
type string
Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]
The user's permission type. This field is null if uses granular permissions
permittedLanguageIds int64[]deprecated
Deprecated (use translateLanguageIds).
List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.
translateLanguageIds int64[]
List of languages user can translate to. If null, all languages editing is permitted.
viewLanguageIds int64[]
List of languages user can view. If null, all languages view is permitted.
stateChangeLanguageIds int64[]
List of languages user can change state to. If null, changing state of all language values is permitted.
computedPermission objectrequired
permissionModel object
Current user's direct permission
scopes string[]required
Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]
Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.
type string
Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]
The user's permission type. This field is null if uses granular permissions
permittedLanguageIds int64[]deprecated
Deprecated (use translateLanguageIds).
List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.
translateLanguageIds int64[]
List of languages user can translate to. If null, all languages editing is permitted.
viewLanguageIds int64[]
List of languages user can view. If null, all languages view is permitted.
stateChangeLanguageIds int64[]
List of languages user can change state to. If null, changing state of all language values is permitted.
origin stringrequired
Possible values: [ORGANIZATION_BASE, DIRECT, ORGANIZATION_OWNER, NONE, SERVER_ADMIN]
permittedLanguageIds int64[]deprecated
Deprecated (use translateLanguageIds).
List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.
stateChangeLanguageIds int64[]
List of languages user can change state to. If null, changing state of all language values is permitted.
translateLanguageIds int64[]
List of languages user can translate to. If null, all languages editing is permitted.
viewLanguageIds int64[]
List of languages user can view. If null, all languages view is permitted.
scopes string[]required
Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]
Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.
type string
Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]
The user's permission type. This field is null if uses granular permissions
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "users": [
      {
        "id": 0,
        "username": "string",
        "name": "string",
        "avatar": {
          "large": "string",
          "thumbnail": "string"
        },
        "organizationRole": "MEMBER",
        "organizationBasePermission": "MANAGE",
        "directPermission": "MANAGE",
        "computedPermission": {
          "permissionModel": "MANAGE",
          "origin": "ORGANIZATION_BASE",
          "stateChangeLanguageIds": [
            200001,
            200004
          ],
          "translateLanguageIds": [
            200001,
            200004
          ],
          "viewLanguageIds": [
            200001,
            200004
          ],
          "scopes": [
            "KEYS_EDIT",
            "TRANSLATIONS_VIEW"
          ],
          "type": "NONE"
        }
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...