Skip to content

example4-split-output.md

Latest commit

 

History

History
927 lines (760 loc) · 23.6 KB

example4-split-output.md

File metadata and controls

927 lines (760 loc) · 23.6 KB

Split Public API v1

split Public API

Terms of service: https://split.io/legal/terms

Servers

Description URL
https://www.neoteroi.xyz/split/api/v1 https://www.neoteroi.xyz/split/api/v1

User

POST /users

Invite a user

??? note "Description" Invites a user to your instance. Only available for the instance owner.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key

Request body

=== "application/json"

```json
[
    {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "john.doe@company.com",
        "firstName": "john",
        "lastName": "Doe",
        "isPending": true,
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "globalRole": {
            "id": 1,
            "name": "owner",
            "scope": "global",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z"
        }
    }
]
```
<span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>



??? hint "Schema of the request body"
    ```json
    {
        "type": "array",
        "items": {
            "$ref": "#/components/schemas/UserInformation"
        }
    }
    ```

Responses

=== "200 OK"

=== "application/json"
    
    
    ```json
    [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "email": "john.doe@company.com",
            "firstName": "john",
            "lastName": "Doe",
            "isPending": true,
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "globalRole": {
                "id": 1,
                "name": "owner",
                "scope": "global",
                "createdAt": "2022-04-13T15:42:05.901Z",
                "updatedAt": "2022-04-13T15:42:05.901Z"
            }
        }
    ]
    ```
    <span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
    
    

    ??? hint "Schema of the response body"
        ```json
        {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/UserInformation"
            }
        }
        ```

=== "401 Unauthorized"

Refer to the common response description: Unauthorized.

GET /users

Retrieve all users

??? note "Description" Retrieve all users from your instance. Only available for the instance owner.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key
cursor query string No Paginate through users by setting the cursor parameter to a nextCursor attribute returned by a previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.
limit query number 100 No The maximum number of items to return.

Responses

=== "200 OK"

=== "application/json"
    
    
    ```json
    {
        "data": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "email": "john.doe@company.com",
                "firstName": "john",
                "lastName": "Doe",
                "isPending": true,
                "createdAt": "2022-04-13T15:42:05.901Z",
                "updatedAt": "2022-04-13T15:42:05.901Z",
                "globalRole": {
                    "id": 1,
                    "name": "owner",
                    "scope": "global",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z"
                }
            }
        ],
        "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
    }
    ```
    <span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
    
    

    ??? hint "Schema of the response body"
        ```json
        {
            "type": "object",
            "properties": {
                "data": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/UserInformation"
                    }
                },
                "nextCursor": {
                    "type": "string",
                    "description": "Paginate through users by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first \"page\" of the collection.",
                    "nullable": true,
                    "example": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
                }
            }
        }
        ```

=== "401 Unauthorized"

Refer to the common response description: Unauthorized.

GET /users/{identifier}

Get user by ID/Email

??? note "Description" Retrieve a user from your instance. Only available for the instance owner.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key
identifier path string No The ID or email of the user.

Responses

=== "200 OK"

Refer to the common response description: UserInformation.

=== "401 Unauthorized"

Refer to the common response description: Unauthorized.

DELETE /users/{identifier}

Delete user by ID/Email

??? note "Description" Deletes a user from your instance. Only available for the instance owner.

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key
identifier path string No The ID or email of the user.
transferId query string No ID of the user to transfer workflows and credentials to. Must not be equal to the to-be-deleted user.

Responses

=== "200 OK"

Refer to the common response description: UserInformation.

=== "401 Unauthorized"

Refer to the common response description: Unauthorized.

Schemas

Error

Name Type Description
code string
description string
message string

RoleInformation

Name Type Description
createdAt string(date-time) Time the role was created.
id number
name string
scope string
updatedAt string(date-time) Last time the role was updaded.

UserDetailsResponse

Name Type Description
data Array<UserInformation>
nextCursor string | null Paginate through users by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

UserInformation

Name Type Description
createdAt string(date-time) Time the user was created.
email string(email)
firstName string User's first name
globalRole RoleInformation
id string
isPending boolean Whether the user finished setting up their account in response to the invitation (true) or not (false).
lastName string User's last name
updatedAt string(date-time) Last time the user was updated.

Common responses

This section describes common responses that are reused across operations.

NotFound

The specified resource was not found.

=== "application/json"

```json
{
    "code": "string",
    "message": "string",
    "description": "string"
}
```
<span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>



??? hint "Schema of the response body"
    ```json
    {
        "required": [
            "code",
            "description",
            "message"
        ],
        "type": "object",
        "properties": {
            "code": {
                "type": "string"
            },
            "message": {
                "type": "string"
            },
            "description": {
                "type": "string"
            }
        }
    }
    ```

Unauthorized

Unauthorized

=== "application/json"

```json
{
    "code": "string",
    "message": "string",
    "description": "string"
}
```
<span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>



??? hint "Schema of the response body"
    ```json
    {
        "required": [
            "code",
            "description",
            "message"
        ],
        "type": "object",
        "properties": {
            "code": {
                "type": "string"
            },
            "message": {
                "type": "string"
            },
            "description": {
                "type": "string"
            }
        }
    }
    ```

UserInformation

Operation successful.

=== "application/json"

```json
{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "john.doe@company.com",
    "firstName": "john",
    "lastName": "Doe",
    "isPending": true,
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "globalRole": {
        "id": 1,
        "name": "owner",
        "scope": "global",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z"
    }
}
```
<span class="small-note">⚠️</span>&nbsp;<em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>



??? hint "Schema of the response body"
    ```json
    {
        "required": [
            "email"
        ],
        "type": "object",
        "properties": {
            "id": {
                "type": "string",
                "readOnly": true,
                "example": "123e4567-e89b-12d3-a456-426614174000"
            },
            "email": {
                "type": "string",
                "format": "email",
                "example": "john.doe@company.com"
            },
            "firstName": {
                "maxLength": 32,
                "type": "string",
                "description": "User's first name",
                "readOnly": true,
                "example": "john"
            },
            "lastName": {
                "maxLength": 32,
                "type": "string",
                "description": "User's last name",
                "readOnly": true,
                "example": "Doe"
            },
            "isPending": {
                "type": "boolean",
                "description": "Whether the user finished setting up their account in response to the invitation (true) or not (false).",
                "readOnly": true
            },
            "createdAt": {
                "type": "string",
                "description": "Time the user was created.",
                "format": "date-time",
                "readOnly": true
            },
            "updatedAt": {
                "type": "string",
                "description": "Last time the user was updated.",
                "format": "date-time",
                "readOnly": true
            },
            "globalRole": {
                "$ref": "#/components/schemas/RoleInformation"
            }
        }
    }
    ```

Common parameters

This section describes common parameters that are reused across operations.

UserIdentifier

Name In Type Default Nullable Description
identifier path string No

Cursor

Name In Type Default Nullable Description
cursor query string No

includeRole

Name In Type Default Nullable Description
includeRole query boolean No

Limit

Name In Type Default Nullable Description
limit query number 100 No

ExecutionId

Name In Type Default Nullable Description
executionId path number No

WorkflowId

Name In Type Default Nullable Description
workflowId path number No

Security schemes

    <tr>
        <td>ApiKeyAuth</td>
        <td>apiKey</td>
        <td></td>
        <td></td>
    </tr>
    
</tbody>
Name Type Scheme Description

Tags

Name Description
User Operations about users.

More documentation

split API documentation

For more information: https://www.neoteroi.xyz/