Skip to main content

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
    filterId int64[]

    Filter users by id

    filterNotId int64[]

    Filter users without id

    filterAgency int64[]

    Filter users from agency

Responses

OK

Schema
    _embedded object
    users object[]
  • Array [
  • avatar object
    large stringrequired
    thumbnail stringrequired
    computedPermission objectrequired
    origin stringrequired

    Possible values: [ORGANIZATION_BASE, DIRECT, ORGANIZATION_OWNER, NONE, SERVER_ADMIN]

    permissionModel object

    Current user's direct permission

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    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.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    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.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    directPermission object
    agency object
    avatar object
    large stringrequired
    thumbnail stringrequired
    id int64required
    name stringrequired
    url string
    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    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.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    id int64required
    name string
    organizationBasePermission objectrequired

    Current user's direct permission

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    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.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    organizationRole string

    Possible values: [MEMBER, OWNER]

    username stringrequired
  • ]
  • page object
    number int64
    size int64
    totalElements int64
    totalPages int64
Loading...