Configure project access

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

Authorization

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

Configure project access for groups and single users. The provided users and groups will be given the roles specified in the payload.

Request

Path Parameters

• projectId string required

application/json

Body

required

projectAddAccessSchema

• roles integer[] required

  A list of role IDs

• groups integer[] required

  A list of group IDs

• users integer[] required

  A list of user IDs

Responses

• 200
• 400
• 401
• 403
• 404
• 415

---

This response has no body.

The request data does not match what we expect.

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": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

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

The requested resource was not found.

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": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

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": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

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": [
    5
  ],
  "groups": [
    5
  ],
  "users": [
    5
  ]
}

curl / cURL

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

python / requests

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

go / native

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

nodejs / native

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

ruby / Net::HTTP

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

csharp / httpclient

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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