reference

Permission

9 endpoints

Permission Group

GET/api/v2/permission-group

List Permission Groups

Requires: PERMISSION_GROUP_create

Responses

200 OK

PermissionGroup[]

accountUuid string (uuid)
code string
id integer (int64)
name string
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v2/permission-group' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "id": 0,
    "name": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

POST/api/v2/permission-group

Create Permission Group

Requires: PERMISSION_GROUP_create

Request body

PermissionGroupDto

accountUuid string (uuid)
id integer (int64)
name string
uuid string (uuid)

Responses

200 OK

PermissionGroupDto

accountUuid string (uuid)
id integer (int64)
name string
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v2/permission-group' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": 0,
  "name": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v2/permission-group/{uuid}

Get Permission Group

Requires: PERMISSION_GROUP_create

path parameters

uuidrequired string (uuid)

Responses

200 OK

PermissionGroup

accountUuid string (uuid)
code string
id integer (int64)
name string
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v2/permission-group/{uuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "string",
  "id": 0,
  "name": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

POST/api/v2/permission-group/{uuid}

Update Permission Group

Requires: PERMISSION_GROUP_create

path parameters

uuidrequired string (uuid)

Request body

PermissionGroupDto

accountUuid string (uuid)
id integer (int64)
name string
uuid string (uuid)

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v2/permission-group/{uuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

POST/api/v2/permission-group/{uuid}/user/{userUuid}

Add User to Permission Group

Requires: PERMISSION_GROUP_create

path parameters

uuidrequired string (uuid)
userUuidrequired string (uuid)

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v2/permission-group/{uuid}/user/{userUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

DELETE/api/v2/permission-group/{uuid}/user/{userUuid}

Remove User from Permission Group

Requires: PERMISSION_GROUP_create

path parameters

uuidrequired string (uuid)
userUuidrequired string (uuid)

Responses

200 OK

Request

curl -X DELETE 'https://app.wxrks.com/api/v2/permission-group/{uuid}/user/{userUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v2/permission/{granteeUuid}

List Permissions

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

path parameters

granteeUuidrequired string (uuid)

Responses

200 OK

PermissionGrantDto[]

active boolean
code string
description string
grantSources PermissionGrantSource[]
granteeIdentifier string
granteeUuid string (uuid)
inherited boolean
module string
name string
permissionUuid string (uuid)
type stringUSER GROUP CLIENT ORGANIZATION ACCOUNT GRANTEE

Request

curl -X GET 'https://app.wxrks.com/api/v2/permission/{granteeUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "active": false,
    "code": "string",
    "description": "string",
    "grantSources": [],
    "granteeIdentifier": "string",
    "granteeUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "inherited": false,
    "module": "string",
    "name": "string",
    "permissionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "USER"
  }
]

POST/api/v2/permission/grantee/{granteeUuid}/permission/{permissionUuid}

Grant Permission for Grantee

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

The grantee is a user, an organization, an org unit or a permission group of your account; any other grantee answers 403. You can only grant a permission you hold yourself, otherwise 403. Granting a permission the grantee already has changes nothing; granting one whose inheritance was turned off for the grantee turns it back on.

path parameters

granteeUuidrequired string (uuid)
A user, organization, org unit or permission group of your account.
permissionUuidrequired string (uuid)
The permission, from listPermissions.

Responses

200 OK

object

Request

curl -X POST 'https://app.wxrks.com/api/v2/permission/grantee/1c9e4b7a-5d2f-4e8a-b3c6-7f0a2d5e9b14/permission/7c4e9b2d-6a1f-4d83-b5e0-3a8c1f7d2e56' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

DELETE/api/v2/permission/grantee/{granteeUuid}/permission/{permissionUuid}

Revoke Permission for Grantee

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

The grantee is a user or a permission group of your account. A grantee outside your account answers 403, an organization or org unit 422. You can only revoke a permission you hold yourself, otherwise 403. When the grantee is a user who inherits the permission from one of their roles, revoking it turns the inheritance off for that user. An account admin can turn off only these inherited permissions, and gets 422 for any other: USER_access_tms, USER_disable_augmented_translation_actions, ORG_UNIT_add_contact, ORG_UNIT_remove_contact, ORG_UNIT_add_tm, ORG_UNIT_remove_tm, ORG_UNIT_edit_tm, ORG_UNIT_add_glossary, ORG_UNIT_remove_glossary, ORG_UNIT_edit_glossary, PROJECT_copy_source_to_target, EDITOR_clear_translations, EDITOR_turn_off_inherited_qa_checks, EDITOR_confirm_all, EDITOR_edit_own_comments, EDITOR_hide_comments and EDITOR_resolve_comments.

path parameters

granteeUuidrequired string (uuid)
A user, organization, org unit or permission group of your account.
permissionUuidrequired string (uuid)
The permission, from listPermissions.

Responses

200 OK

object

Request

curl -X DELETE 'https://app.wxrks.com/api/v2/permission/grantee/1c9e4b7a-5d2f-4e8a-b3c6-7f0a2d5e9b14/permission/7c4e9b2d-6a1f-4d83-b5e0-3a8c1f7d2e56' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"