Services
Identities
create
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.CreateIdentityRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
get
Example Usage
Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
identity_id | Optional[str] | :heavy_minus_sign: | N/A | id_1234 |
external_id | Optional[str] | :heavy_minus_sign: | N/A | id_1234 |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
list
Example Usage
Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
environment | Optional[str] | :heavy_minus_sign: | N/A | |
limit | Optional[int] | :heavy_minus_sign: | N/A | 100 |
cursor | Optional[str] | :heavy_minus_sign: | N/A | |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
update
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.UpdateIdentityRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
delete
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.DeleteIdentityRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
Was this page helpful?