Set users and groups to roles in the current project

PUT <your-unleash-url>/api/admin/projects/:projectId/access

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Sets all groups, users and their roles for the given project, overriding any existing configuration.

Request

Path Parameters

• projectId string required

application/json

Body

required

projectAccessConfigurationSchema

• roles object[]required

  A list of roles that are available within this project.

  Array [

  id integer

  Possible values: >= 1

  The id of the role.

  groups integer[]

  A list of group ids that will be assigned this role

  users integer[]

  A list of user ids that will be assigned this role

  ]

Responses

• 200
• 401
• 403

---

This response has no body.

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

projectId — path required

Body required

{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}

curl / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

python / requests

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

go / native

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

nodejs / axios

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

csharp / RestSharp

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

php / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

java / OkHttp

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'

powershell / RestMethod

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "id": 1,
      "groups": [
        1,
        2,
        3
      ],
      "users": [
        1,
        2,
        3
      ]
    }
  ]
}'