Skip to content

incident_io_client.api.users_v2.users_v2_list

asyncio async 

asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET
) -> Optional[UsersV2ListResponseBody]

List Users V2

List users for an organisation.

Parameters:

Name Type Description Default
email Union[Unset, str]
UNSET
slack_user_id Union[Unset, str]
UNSET
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[UsersV2ListResponseBody]

UsersV2ListResponseBody
Source code in incident_io_client/api/users_v2/users_v2_list.py 
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
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
) -> Optional[UsersV2ListResponseBody]:
    """List Users V2

     List users for an organisation.

    Args:
        email (Union[Unset, str]):
        slack_user_id (Union[Unset, str]):
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        UsersV2ListResponseBody
    """

    return (
        await asyncio_detailed(
            client=client,
            email=email,
            slack_user_id=slack_user_id,
            page_size=page_size,
            after=after,
        )
    ).parsed

asyncio_detailed async 

asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET
) -> Response[UsersV2ListResponseBody]

List Users V2

List users for an organisation.

Parameters:

Name Type Description Default
email Union[Unset, str]
UNSET
slack_user_id Union[Unset, str]
UNSET
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[UsersV2ListResponseBody]

Response[UsersV2ListResponseBody]
Source code in incident_io_client/api/users_v2/users_v2_list.py 
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
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
) -> Response[UsersV2ListResponseBody]:
    """List Users V2

     List users for an organisation.

    Args:
        email (Union[Unset, str]):
        slack_user_id (Union[Unset, str]):
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[UsersV2ListResponseBody]
    """

    kwargs = _get_kwargs(
        email=email,
        slack_user_id=slack_user_id,
        page_size=page_size,
        after=after,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync 

sync(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET
) -> Optional[UsersV2ListResponseBody]

List Users V2

List users for an organisation.

Parameters:

Name Type Description Default
email Union[Unset, str]
UNSET
slack_user_id Union[Unset, str]
UNSET
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[UsersV2ListResponseBody]

UsersV2ListResponseBody
Source code in incident_io_client/api/users_v2/users_v2_list.py 
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
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
) -> Optional[UsersV2ListResponseBody]:
    """List Users V2

     List users for an organisation.

    Args:
        email (Union[Unset, str]):
        slack_user_id (Union[Unset, str]):
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        UsersV2ListResponseBody
    """

    return sync_detailed(
        client=client,
        email=email,
        slack_user_id=slack_user_id,
        page_size=page_size,
        after=after,
    ).parsed

sync_detailed 

sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET
) -> Response[UsersV2ListResponseBody]

List Users V2

List users for an organisation.

Parameters:

Name Type Description Default
email Union[Unset, str]
UNSET
slack_user_id Union[Unset, str]
UNSET
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[UsersV2ListResponseBody]

Response[UsersV2ListResponseBody]
Source code in incident_io_client/api/users_v2/users_v2_list.py 
 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
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    email: Union[Unset, str] = UNSET,
    slack_user_id: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
) -> Response[UsersV2ListResponseBody]:
    """List Users V2

     List users for an organisation.

    Args:
        email (Union[Unset, str]):
        slack_user_id (Union[Unset, str]):
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[UsersV2ListResponseBody]
    """

    kwargs = _get_kwargs(
        email=email,
        slack_user_id=slack_user_id,
        page_size=page_size,
        after=after,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)