The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

OVID / OpenAPI-Client-OpenAI-0.20 / lib / OpenAPI / Client / OpenAI / Path / organization-projects-project_id-users.pod 

            

              
—
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

              
=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users - Documentation for the /organization/projects/{project_id}/users path.
=head1 DESCRIPTION
This document describes the API endpoint at C</organization/projects/{project_id}/users>.
See the C<examples/> directory in the distribution for examples of how to use this.
=head2 C<GET /organization/projects/{project_id}/users>
Returns a list of users in the project.
=head3 Operation ID
C<list-project-users>
    $client->list-project-users( ... );
=head3 Parameters
=over 4
=item * C<project_id> (in path) (Required) - The ID of the project.
Type: C<string>
=item * C<limit> (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Type: C<integer>
Default: C<20>
=item * C<after> (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
Type: C<string>
=back
=head3 Responses
=head3 Status Code: C<200>
Project users listed successfully.
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "data" : [
          null
       ]
    }
=back
=head3 Status Code: C<400>
Error response when project is archived.
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "error" : null
    }
=back
=head2 C<POST /organization/projects/{project_id}/users>
Adds a user to the project. Users must already be members of the organization to be added to a project.
=head3 Operation ID
C<create-project-user>
    $client->create-project-user( ... );
=head3 Parameters
=over 4
=item * C<project_id> (in path) (Required) - The ID of the project.
Type: C<string>
=back
=head3 Request Body
=head3 Content Type: C<application/json>
=head3 Responses
=head3 Status Code: C<200>
User added to project successfully.
Content Types:
=over 4
=item * C<application/json>
=back
=head3 Status Code: C<400>
Error response for various conditions.
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "error" : null
    }
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.
=cut