oCoreoCore Docs
API Reference

Project Access

List my project access

Returns all projects the current user has access to.

GET
/project-access

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/project-access" \
  -H "Authorization: <token>"

OK

{
  "items": [
    {
      "createdAt": "string",
      "id": "string",
      "productionAccess": true,
      "projectId": "string",
      "projectName": "string",
      "roleId": "string",
      "roleName": "string",
      "userEmail": "string",
      "userId": "string",
      "userName": "string"
    }
  ]
}

List project access records

Returns all access records for a project.

GET
/projects/{id}/access

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Project ID

curl -X GET "//api.ocore.dev/api/projects/<string>/access" \
  -H "Authorization: <token>"

OK

{
  "items": [
    {
      "createdAt": "string",
      "id": "string",
      "productionAccess": true,
      "projectId": "string",
      "projectName": "string",
      "roleId": "string",
      "roleName": "string",
      "userEmail": "string",
      "userId": "string",
      "userName": "string"
    }
  ]
}

Grant project access

Grants a user access to a project with a specific role.

POST
/projects/{id}/access

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Access grant request

productionAccessboolean
roleIdRequiredstring
userIdRequiredstring

Path Parameters

idRequiredstring

Project ID

curl -X POST "//api.ocore.dev/api/projects/<string>/access" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "productionAccess": true,
    "roleId": "string",
    "userId": "string"
  }'

Created

{
  "createdAt": "string",
  "id": "string",
  "productionAccess": true,
  "projectId": "string",
  "projectName": "string",
  "roleId": "string",
  "roleName": "string",
  "userEmail": "string",
  "userId": "string",
  "userName": "string"
}

Revoke project access

Revokes a project access record.

DELETE
/projects/{id}/access/{accessId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Project ID

accessIdRequiredstring

Access record ID

curl -X DELETE "//api.ocore.dev/api/projects/<string>/access/<string>" \
  -H "Authorization: <token>"

No Content

Update project access

Updates the role or production access flag for a project access record.

PUT
/projects/{id}/access/{accessId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Access update request

productionAccessboolean
roleIdstring

Path Parameters

idRequiredstring

Project ID

accessIdRequiredstring

Access record ID

curl -X PUT "//api.ocore.dev/api/projects/<string>/access/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "productionAccess": true,
    "roleId": "string"
  }'

OK

{
  "createdAt": "string",
  "id": "string",
  "productionAccess": true,
  "projectId": "string",
  "projectName": "string",
  "roleId": "string",
  "roleName": "string",
  "userEmail": "string",
  "userId": "string",
  "userName": "string"
}

Was this page helpful?
Edit on GitHub

Deployments

Previous Page

Promotions

Next Page