Set users and groups to roles in the current project

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

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

Request

Path Parameters

projectId stringrequired

application/json

Bodyrequired

projectAccessConfigurationSchema

roles object[]required
A list of roles that are available within this project.
Array [
idinteger
The id of the role.
Possible values: >= 1
Example: 1
groupsinteger[]
A list of group ids that will be assigned this role
Example: [1,2,3]
usersinteger[]
A list of user ids that will be assigned this role
Example: [1,2,3]
]

Responses

200

This response has no body.

401

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

{
  "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."
}

403

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

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

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

Authorization: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

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

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

Body required

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

ResponseClear

Click the Send API Request button above and see the response here!