openai-client-base 0.12.0

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
# \RolesApi

All URIs are relative to *https://api.openai.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_project_role**](RolesApi.md#create_project_role) | **POST** /projects/{project_id}/roles | Creates a custom role for a project.
[**create_role**](RolesApi.md#create_role) | **POST** /organization/roles | Creates a custom role for the organization.
[**delete_project_role**](RolesApi.md#delete_project_role) | **DELETE** /projects/{project_id}/roles/{role_id} | Deletes a custom role from a project.
[**delete_role**](RolesApi.md#delete_role) | **DELETE** /organization/roles/{role_id} | Deletes a custom role from the organization.
[**list_project_roles**](RolesApi.md#list_project_roles) | **GET** /projects/{project_id}/roles | Lists the roles configured for a project.
[**list_roles**](RolesApi.md#list_roles) | **GET** /organization/roles | Lists the roles configured for the organization.
[**update_project_role**](RolesApi.md#update_project_role) | **POST** /projects/{project_id}/roles/{role_id} | Updates an existing project role.
[**update_role**](RolesApi.md#update_role) | **POST** /organization/roles/{role_id} | Updates an existing organization role.



## create_project_role

> models::Role create_project_role(project_id, public_create_organization_role_body)
Creates a custom role for a project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**public_create_organization_role_body** | [**PublicCreateOrganizationRoleBody**](PublicCreateOrganizationRoleBody.md) | Parameters for the project role you want to create. | [required] |

### Return type

[**models::Role**](Role.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_role

> models::Role create_role(public_create_organization_role_body)
Creates a custom role for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**public_create_organization_role_body** | [**PublicCreateOrganizationRoleBody**](PublicCreateOrganizationRoleBody.md) | Parameters for the role you want to create. | [required] |

### Return type

[**models::Role**](Role.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_project_role

> models::RoleDeletedResource delete_project_role(project_id, role_id)
Deletes a custom role from a project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**role_id** | **String** | The ID of the role to delete. | [required] |

### Return type

[**models::RoleDeletedResource**](RoleDeletedResource.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_role

> models::RoleDeletedResource delete_role(role_id)
Deletes a custom role from the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**role_id** | **String** | The ID of the role to delete. | [required] |

### Return type

[**models::RoleDeletedResource**](RoleDeletedResource.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_project_roles

> models::PublicRoleListResource list_project_roles(project_id, limit, after, order)
Lists the roles configured for a project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to inspect. | [required] |
**limit** | Option<**i32**> | A limit on the number of roles to return. Defaults to 1000. |  |[default to 1000]
**after** | Option<**String**> | Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles. |  |
**order** | Option<**String**> | Sort order for the returned roles. |  |[default to asc]

### Return type

[**models::PublicRoleListResource**](PublicRoleListResource.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_roles

> models::PublicRoleListResource list_roles(limit, after, order)
Lists the roles configured for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**i32**> | A limit on the number of roles to return. Defaults to 1000. |  |[default to 1000]
**after** | Option<**String**> | Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles. |  |
**order** | Option<**String**> | Sort order for the returned roles. |  |[default to asc]

### Return type

[**models::PublicRoleListResource**](PublicRoleListResource.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_project_role

> models::Role update_project_role(project_id, role_id, public_update_organization_role_body)
Updates an existing project role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**role_id** | **String** | The ID of the role to update. | [required] |
**public_update_organization_role_body** | [**PublicUpdateOrganizationRoleBody**](PublicUpdateOrganizationRoleBody.md) | Fields to update on the project role. | [required] |

### Return type

[**models::Role**](Role.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_role

> models::Role update_role(role_id, public_update_organization_role_body)
Updates an existing organization role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**role_id** | **String** | The ID of the role to update. | [required] |
**public_update_organization_role_body** | [**PublicUpdateOrganizationRoleBody**](PublicUpdateOrganizationRoleBody.md) | Fields to update on the role. | [required] |

### Return type

[**models::Role**](Role.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)