openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
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

# \GroupOrganizationRoleAssignmentsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**assign_group_role**](GroupOrganizationRoleAssignmentsApi.md#assign_group_role) | **POST** /organization/groups/{group_id}/roles | Assigns an organization role to a group within the organization.
[**list_group_role_assignments**](GroupOrganizationRoleAssignmentsApi.md#list_group_role_assignments) | **GET** /organization/groups/{group_id}/roles | Lists the organization roles assigned to a group within the organization.
[**unassign_group_role**](GroupOrganizationRoleAssignmentsApi.md#unassign_group_role) | **DELETE** /organization/groups/{group_id}/roles/{role_id} | Unassigns an organization role from a group within the organization.



## assign_group_role

> models::GroupRoleAssignment assign_group_role(group_id, public_assign_organization_group_role_body)
Assigns an organization role to a group within the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The ID of the group that should receive the organization role. | [required] |
**public_assign_organization_group_role_body** | [**PublicAssignOrganizationGroupRoleBody**](PublicAssignOrganizationGroupRoleBody.md) | Identifies the organization role to assign to the group. | [required] |

### Return type

[**models::GroupRoleAssignment**](GroupRoleAssignment.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)


## list_group_role_assignments

> models::RoleListResource list_group_role_assignments(group_id, limit, after, order)
Lists the organization roles assigned to a group within the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The ID of the group whose organization role assignments you want to list. | [required] |
**limit** | Option<**i32**> | A limit on the number of organization role assignments to return. |  |
**after** | Option<**String**> | Cursor for pagination. Provide the value from the previous response's `next` field to continue listing organization roles. |  |
**order** | Option<**String**> | Sort order for the returned organization roles. |  |

### Return type

[**models::RoleListResource**](RoleListResource.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)


## unassign_group_role

> models::DeletedRoleAssignmentResource unassign_group_role(group_id, role_id)
Unassigns an organization role from a group within the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The ID of the group to modify. | [required] |
**role_id** | **String** | The ID of the organization role to remove from the group. | [required] |

### Return type

[**models::DeletedRoleAssignmentResource**](DeletedRoleAssignmentResource.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)