User project permission

The user project permission.

Create a user project permission

Create a new user project permission for a user and a project.

If the user project permission for the project and the user already exists, it will be updated if necessary.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing user project permission information.

user required	string or integer The user of the user project permission. Without a user the request will always return a `403 Forbidden` response.
project required	string or integer The project of the user project permission. Without a project the request will always return a `403 Forbidden` response.
umask required	integer The permission level of the user project permission. 0 - None 1 - Read 2 - Write 3 - Admin Enum: 0 1 2 3

Responses

200

Successful operation

201

Successful operation

422

Unprocessable Content

post/userprojectpermission

Request samples

Payload
curl

application/json

{"user": 4,
"project": 1,
"umask": 2
}

Response samples

application/json

{"success": true,
"hash": "f273cad070a6b8e9edbb7ce6407e4c5a795ed925",
"data": {"hash": "c4c32077e3b3d7d23fad99deca591125ec6fe822",
"umask": 2,
"created_time": "2022-08-31T09:50:22.000000Z",
"modified_time": "2022-08-31T09:50:22.000000Z",
"modified_user_time": "2022-08-31T09:50:22.000000Z",
"model": "UserProjectPermission",
"user": {"id": 4,
"hash": "59a3ef6ef6bc76e50b85b3ecd2d3d9eb8691e576",
"name": "Franz Beckenbauer",
"first_name": "Franz",
"last_name": "Beckenbauer",
"position": "Imperator",
"department": "Anti-corruption",
"organization": "Nordantech",
"email": "derkaiser@nordantech.com",
"status": 1,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-08-22T10:40:45.000000Z",
"modified_user_time": "2022-08-01T15:23:51.000000Z",
"model": "User",
"user_hub_permission": {"hash": "a48e32fef60bce912fe39d7ce8e7c0c0b0bd5a6f",
"umask": 0,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-06-27T12:11:52.000000Z",
"modified_user_time": "2022-06-27T12:11:52.000000Z",
"model": "UserHubPermission"
}
},
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-08-22T10:09:18.000000Z",
"modified_user_time": "2022-07-28T10:46:44.000000Z",
"model": "Project"
}
},
"timestamp": 1681291648980
}

Get all user project permissions

Get all user project permissions of the authenticated hub.

SecurityJWT

Request

query Parameters

project	string or integer Filter the user project permission list for a project.
program	string or integer Filter the user project permission list for a program.
page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

422

Unprocessable Content

get/userprojectpermission

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "f7db7d3a0a3fd42ec0bba2c2905925e116ee9a7c",
"data": [{"hash": "c4c32077e3b3d7d23fad99deca591125ec6fe822",
"umask": 2,
"created_time": "2022-08-31T09:50:22.000000Z",
"modified_time": "2022-08-31T09:50:22.000000Z",
"modified_user_time": "2022-08-31T09:50:22.000000Z",
"model": "UserProjectPermission",
"user": {"id": 4,
"hash": "59a3ef6ef6bc76e50b85b3ecd2d3d9eb8691e576",
"name": "Franz Beckenbauer",
"first_name": "Franz",
"last_name": "Beckenbauer",
"position": "Imperator",
"department": "Anti-corruption",
"organization": "Nordantech",
"email": "derkaiser@nordantech.com",
"status": 1,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-08-22T10:40:45.000000Z",
"modified_user_time": "2022-08-01T15:23:51.000000Z",
"model": "User",
"user_hub_permission": {"hash": "a48e32fef60bce912fe39d7ce8e7c0c0b0bd5a6f",
"umask": 0,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-06-27T12:11:52.000000Z",
"modified_user_time": "2022-06-27T12:11:52.000000Z",
"model": "UserHubPermission"
}
},
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-08-22T10:09:18.000000Z",
"modified_user_time": "2022-07-28T10:46:44.000000Z",
"model": "Project"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 1,
"total": 1,
"limit": 1000,
"pages": 1
},
"timestamp": 1661941089888
}

Get a user project permission

Get a user project permission.

SecurityJWT

Request

path Parameters

userprojectpermission

required

string

The hash of the user project permission.

Responses

200

Successful operation

404

Not Found

get/userprojectpermission/{userprojectpermission}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "cb7e9c89fc74f6c34734e173c3e5d0ba22f14163",
"data": {"hash": "c4c32077e3b3d7d23fad99deca591125ec6fe822",
"umask": 2,
"created_time": "2022-08-31T09:50:22.000000Z",
"modified_time": "2022-08-31T09:50:22.000000Z",
"modified_user_time": "2022-08-31T09:50:22.000000Z",
"model": "UserProjectPermission",
"user": {"id": 4,
"hash": "59a3ef6ef6bc76e50b85b3ecd2d3d9eb8691e576",
"name": "Franz Beckenbauer",
"first_name": "Franz",
"last_name": "Beckenbauer",
"position": "Imperator",
"department": "Anti-corruption",
"organization": "Nordantech",
"email": "derkaiser@nordantech.com",
"status": 1,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-08-22T10:40:45.000000Z",
"modified_user_time": "2022-08-01T15:23:51.000000Z",
"model": "User",
"user_hub_permission": {"hash": "a48e32fef60bce912fe39d7ce8e7c0c0b0bd5a6f",
"umask": 0,
"created_time": "2022-06-27T12:11:04.000000Z",
"modified_time": "2022-06-27T12:11:52.000000Z",
"modified_user_time": "2022-06-27T12:11:52.000000Z",
"model": "UserHubPermission"
}
},
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-08-22T10:09:18.000000Z",
"modified_user_time": "2022-07-28T10:46:44.000000Z",
"model": "Project"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1661941462784
}

Update a user project permission

Update a user project permission.

SecurityJWT

Request

path Parameters

userprojectpermission

required

string

The hash of the user project permission.

Request Body schema: application/json

A JSON object containing user project permission information

umask

integer

The user project permission umask.

0 - None
1 - Read
2 - Write
3 - Admin

Enum: 0 1 2 3

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/userprojectpermission/{userprojectpermission}

Request samples

Payload
curl

application/json

{"umask": 0
}

Response samples

application/json

{"success": true,
"hash": "cedc8371f9551d9ac90d901e2cc73d8658d70ac5",
"data": {"hash": "c4c32077e3b3d7d23fad99deca591125ec6fe822",
"umask": 0,
"created_time": "2022-08-31T09:50:22.000000Z",
"modified_time": "2022-08-31T10:31:58.000000Z",
"modified_user_time": "2022-08-31T10:31:58.000000Z",
"model": "UserProjectPermission",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1661941918533
}

Delete a user project permission

Delete a user project permission.

SecurityJWT

Request

path Parameters

userprojectpermission

required

string

The hash of the user project permission.

Responses

200

Successful operation

404

Not Found

delete/userprojectpermission/{userprojectpermission}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1661942316609
}

➔ Next to User program permission