SSO O2 Pro Swagger

https://sso.o2.pro/swagger/
Admin
SSO O2 Pro Swagger is an API documentation and testing interface for the O2 Pro single sign-on...
Tokens:5,584
Snippets:29
Trust Score:5.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### SSO Service Start Employment Process

Source: https://sso.o2.pro/swagger/index

Initiates the employment process using a POST request to the /profile/start_employment_process endpoint.

```OpenAPI
POST /profile/start_employment_process
Start Employment Process
```

--------------------------------

### SSO Service Profile Retrieval

Source: https://sso.o2.pro/swagger/index

Allows retrieving user profile information using a GET request to the /profile endpoint.

```OpenAPI
GET /profile
Get user profile
```

--------------------------------

### Start Employment Process

Source: https://sso.o2.pro/swagger/doc

Initiates the employment process within the Camunda workflow engine. This endpoint requires a valid Bearer token for authentication and accepts a JSON request body. It returns a status indicating success or failure, along with potential error responses for invalid requests or server errors.

```json
{
    "post": {
        "security": [
            {
                "BearerAuth": []
            }
        ],
        "description": "Starts employment process in camunda",
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Employement"
        ],
        "summary": "Start Employment Process",
        "responses": {
            "200": {
                "description": "Employment process started successfully",
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.Status"
                }
            },
            "400": {
                "description": "Invalid request body",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            },
            "500": {
                "description": "Internal server error",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            }
        }
    }
}
```

--------------------------------

### SSO Service Protect Endpoint

Source: https://sso.o2.pro/swagger/index

The protect endpoint is available for securing resources within the SSO service. It is accessible via a GET request.

```OpenAPI
GET /protect
Protect endpoint
```

--------------------------------

### SSO Service Health Check

Source: https://sso.o2.pro/swagger/index

Provides a health check for the SSO service, accessible via a GET request to the /live endpoint.

```OpenAPI
GET /live
Health check
```

--------------------------------

### Get User Profile

Source: https://sso.o2.pro/swagger/doc

Retrieves the profile information for the authenticated user. This endpoint requires Bearer token authentication and returns the user's profile details in JSON format.

```json
{
    "get": {
        "security": [
            {
                "BearerAuth": []
            }
        ],
        "description": "Retrieves the profile information for the authenticated user",
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Profile"
        ],
        "summary": "Get user profile",
        "responses": {
            "200": {
                "description": "OK",
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.User"
                }
            },
            "400": {
                "description": "Invalid request body",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            },
            "500": {
                "description": "Internal server error",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            }
        }
    }
}
```

--------------------------------

### SSO Service Group Management - Add User

Source: https://sso.o2.pro/swagger/index

Allows adding a user to a group via a POST request to the /group/add_user endpoint.

```OpenAPI
POST /group/add_user
Join a group
```

--------------------------------

### Confirm User Data (API)

Source: https://sso.o2.pro/swagger/doc

Confirms and validates user data before proceeding with the employment process. Requires Bearer authentication. Accepts and produces JSON.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "Confirms and validates user data before proceeding with employment process",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Employement"
    ],
    "summary": "Confirm User Data",
    "responses": {
        "200": {
            "description": "User data confirmed successfully",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        },
        "400": {
            "description": "Invalid request or user data validation failed",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "401": {
            "description": "Unauthorized - Invalid or missing access token",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error"
        }
    }
}
```

--------------------------------

### SSO Service Authorization Endpoint

Source: https://sso.o2.pro/swagger/index

The SSO service provides an authorization endpoint to obtain access tokens. This typically involves a POST request to the /authorize endpoint.

```OpenAPI
POST /authorize
Authorize endpoint
```

--------------------------------

### SSO Service Employee Availability Update

Source: https://sso.o2.pro/swagger/index

Enables updating employee availability information through a PATCH request to the /employee/availability endpoint.

```OpenAPI
PATCH /employee/availability
Employee availability
```

--------------------------------

### SSO Service Sign Document with SMS

Source: https://sso.o2.pro/swagger/index

Enables signing a document with an SMS code via a POST request to the /sign_document endpoint.

```OpenAPI
POST /sign_document
Sign document with SMS code
```

--------------------------------

### SSO Service Confirm User Data

Source: https://sso.o2.pro/swagger/index

Confirms user data within the SSO service via a POST request to the /profile/confirm_user_data endpoint.

```OpenAPI
POST /profile/confirm_user_data
Confirm User Data
```

--------------------------------

### SSO Service Profile Update

Source: https://sso.o2.pro/swagger/index

Allows updating user profile information using a PATCH request to the /profile endpoint.

```OpenAPI
PATCH /profile
Update user profile
```

--------------------------------

### SSO Service Renew Access Token

Source: https://sso.o2.pro/swagger/index

Allows for the renewal of access tokens using a POST request to the /renew endpoint.

```OpenAPI
POST /renew
Renew access token
```

--------------------------------

### Authorize SSO Endpoint

Source: https://sso.o2.pro/swagger/doc

Handles the authorization process for the SSO service. It accepts an authorization request and returns an access token upon successful authentication. It also defines error responses for invalid requests and internal server errors.

```json
{
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Auth"
    ],
    "summary": "Authorize endpoint",
    "parameters": [
        {
            "description": "Authorization request",
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.AuthorizeRequest"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "Access token",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Token"
            }
        },
        "400": {
            "description": "Invalid request body",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### Update User Profile (API)

Source: https://sso.o2.pro/swagger/doc

Updates the profile information for the authenticated user. Requires Bearer authentication and a user profile update request body. Accepts and produces JSON.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "Updates the profile information for the authenticated user",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Profile"
    ],
    "summary": "Update user profile",
    "parameters": [
        {
            "description": "User profile update request",
            "name": "request",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.User"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "User profile updated successfully",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        },
        "400": {
            "description": "Invalid request body",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### SSO Service Profile Deletion

Source: https://sso.o2.pro/swagger/index

Enables deleting a user profile via a DELETE request to the /profile endpoint.

```OpenAPI
DELETE /profile
Delete user profile
```

--------------------------------

### Sign Document with SMS Code

Source: https://sso.o2.pro/swagger/doc

This endpoint enables users to sign a document using an SMS verification code. It requires a request body containing document signing details. Successful signing returns a status, while errors can occur due to invalid input or server issues.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "This endpoint allows users to sign a document using SMS verification code",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Employement"
    ],
    "summary": "Sign document with SMS code",
    "parameters": [
        {
            "description": "Document signing request containing SMS code and document details",
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.SignDocumentRequest"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "Document successfully signed",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        },
        "400": {
            "description": "Invalid request: missing or invalid SMS code, document ID, or sign TSS ID",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### Protect Endpoint

Source: https://sso.o2.pro/swagger/doc

This endpoint is designed to protect resources by generating a CSRF token. It handles JSON requests and responses and is tagged under 'Auth'. Successful requests return a status indicating token generation, while errors may occur due to internal server issues.

```json
{
    "get": {
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Auth"
        ],
        "summary": "Protect endpoint",
        "responses": {
            "200": {
                "description": "CSRF token generated successfully",
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.Status"
                }
            },
            "500": {
                "description": "internal server error",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            }
        }
    }
}
```

--------------------------------

### Delete User Profile (API)

Source: https://sso.o2.pro/swagger/doc

Deletes the profile for the authenticated user. Requires Bearer authentication. Accepts and produces JSON.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "Deletes the profile for the authenticated user",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Profile"
    ],
    "summary": "Delete user profile",
    "responses": {
        "200": {
            "description": "KeycloackUser profile deleted successfully",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        },
        "400": {
            "description": "Invalid request body",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### Request Code Endpoint

Source: https://sso.o2.pro/swagger/doc

This endpoint is used to request a code, likely as part of an authorization flow. It accepts JSON requests and produces JSON responses, categorized under the 'Auth' tag. Specific parameters for the code request are detailed in the 'parameters' section.

```json
{
    "post": {
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Auth"
        ],
        "summary": "Request code endpoint",
        "parameters": [
            {
                "description": "",
                "name": "body",
                "in": "body",
                "required": true,
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.RequestCode"
                }
            }
        ]
    }
}
```

--------------------------------

### SSO Service Request Code Endpoint

Source: https://sso.o2.pro/swagger/index

This endpoint is used to request an authorization code, typically as part of an OAuth 2.0 flow. It is accessed via a POST request.

```OpenAPI
POST /request_code
Request code endpoint
```

--------------------------------

### SSO Service Group Management - Remove User

Source: https://sso.o2.pro/swagger/index

Enables removing a user from a group using a POST request to the /group/remove_user endpoint.

```OpenAPI
POST /group/remove_user
Leave a group
```

--------------------------------

### Request SMS Code

Source: https://sso.o2.pro/swagger/doc

This endpoint allows users to request an SMS verification code. It requires a phone number and a CSRF token. Successful requests return a status, while errors can occur due to unauthorized access or internal server issues.

```json
{
    "parameters": [
        {
            "description": "Phone number (11 digits, starts with 7)",
            "name": "phone",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Phone"
            }
        },
        {
            "description": "CSRF token",
            "name": "X-Csrf-Token",
            "in": "header",
            "required": true
        }
    ],
    "responses": {
        "200": {
            "description": "SMS code requested successfully",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        },
        "403": {
            "description": "unauthorized",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### Update Employee Availability

Source: https://sso.o2.pro/swagger/doc

Allows updating an employee's availability status. This endpoint requires authentication via Bearer token and accepts employee availability details in the request body. It returns an OK status on success or error responses for invalid input or server issues.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "Employee availability",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Employee"
    ],
    "summary": "Employee availability",
    "parameters": [
        {
            "description": "Employee availability request",
            "name": "request",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.EmployeeAvailability"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "OK",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.EmployeeAvailabilityResponse"
            }
        },
        "400": {
            "description": "Invalid request body",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        },
        "500": {
            "description": "Internal server error",
            "schema": {
                "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
            }
        }
    }
}
```

--------------------------------

### Add User to Group

Source: https://sso.o2.pro/swagger/doc

Enables adding a specified user to a specified group within the SSO system. This operation is secured with a Bearer token and requires the User ID and Group name in the request body. It confirms successful addition or provides error details.

```json
{
    "security": [
        {
            "BearerAuth": []
        }
    ],
    "description": "Adds the specified user to the specified group",
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [
        "Group"
    ],
    "summary": "Join a group",
    "parameters": [
        {
            "description": "User ID and Group name",
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
                "$ref": "#/definitions/sso_internal_models.AddUserToGroupRequest"
            }
        }
    ],
    "responses": {
        "200": {
            "description": "User successfully added to group",
            "schema": {
                "$ref": "#/definitions/sso_internal_models.Status"
            }
        }
    }
}
```

--------------------------------

### Renew Access Token

Source: https://sso.o2.pro/swagger/doc

Allows clients to renew their access token using a valid refresh token. The request body must contain the refresh token. Successful renewal returns a new access token, while invalid requests or server errors will result in appropriate error responses.

```json
{
    "post": {
        "description": "This endpoint allows clients to renew their access token using a valid refresh token.",
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Auth"
        ],
        "summary": "Renew access token",
        "parameters": [
            {
                "description": "Refresh token request containing the refresh token",
                "name": "body",
                "in": "body",
                "required": true,
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.RefreshToken"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Successfully renewed access token",
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.Token"
                }
            },
            "400": {
                "description": "Invalid request body, e.g., missing or malformed refresh token",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            },
            "500": {
                "description": "Internal server error, e.g., failure to communicate with the authorization server",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            }
        }
    }
}
```

--------------------------------

### Health Check

Source: https://sso.o2.pro/swagger/doc

Performs a health check on the service. This endpoint is used to verify the operational status of the application and returns a status code indicating success or failure.

```json
{
    "get": {
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Health"
        ],
        "summary": "Health check",
        "responses": {
            "200": {
                "description": "ok",
                "schema": {
                    "$ref": "#/definitions/internal_handler_health.Status"
                }
            },
            "500": {
                "description": "internal server error",
                "schema": {
                    "$ref": "#/definitions/internal_handler_health.ErrorResponse"
                }
            }
        }
    }
}
```

--------------------------------

### Remove User from Group

Source: https://sso.o2.pro/swagger/doc

Removes a specified user from a specified group. This operation requires authentication and expects a JSON payload containing the User ID and Group name.

```json
{
    "post": {
        "security": [
            {
                "BearerAuth": []
            }
        ],
        "description": "Removes the specified user from the specified group",
        "consumes": [
            "application/json"
        ],
        "produces": [
            "application/json"
        ],
        "tags": [
            "Group"
        ],
        "summary": "Leave a group",
        "parameters": [
            {
                "description": "User ID and Group name",
                "name": "body",
                "in": "body",
                "required": true,
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.RemoveUserFromGroupRequest"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "User successfully removed from group",
                "schema": {
                    "$ref": "#/definitions/sso_internal_models.Status"
                }
            },
            "400": {
                "description": "Invalid request",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            },
            "404": {
                "description": "Entity not found",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            },
            "500": {
                "description": "Internal server error",
                "schema": {
                    "$ref": "#/definitions/sso_pkg_utils.ErrorResponse"
                }
            }
        }
    }
}
```
Tokens:
Raw