API Documentation Report
GRANT: Parameter Descriptions
Total Parameters: 30 Parameter with Description: 30
Parameter without Descriptions
GRANT: Response Parameter Descriptions
Total Response Parameters: 30 Response Parameter with Description: 30
Response Parameter without Descriptions
GRANT: Response Parameter Examples
Total Response Parameters: 30 Response Parameter with Example: 30
Response Parameter without Examples
AUTHENTICATION: Parameter Descriptions
Total Parameters: 36 Parameter with Description: 26
Parameter without Descriptions
- POST /api/access-keys - name
- POST /api/access-keys - userID
- POST /api/device/approve - userCode
- POST /api/device/status - deviceCode
- POST /api/login - accessKey
- POST /api/login - oidc
- POST /api/login - passwordCredentials
- POST /api/password-reset - password
- POST /api/password-reset - token
- POST /api/password-reset-request - email
AUTHENTICATION: Response Parameter Descriptions
Total Response Parameters: 42 Response Parameter with Description: 25
Response Parameter without Descriptions
- POST /api/access-keys - accessKey
- POST /api/access-keys - id
- POST /api/access-keys - issuedFor
- POST /api/access-keys - name
- POST /api/access-keys - providerID
- POST /api/device/status - deviceCode
- POST /api/device/status - login
- POST /api/login - accessKey
- POST /api/login - name
- POST /api/login - organizationName
- POST /api/login - passwordUpdateRequired
- POST /api/login - userID
- POST /api/password-reset - accessKey
- POST /api/password-reset - name
- POST /api/password-reset - organizationName
- POST /api/password-reset - passwordUpdateRequired
- POST /api/password-reset - userID
AUTHENTICATION: Response Parameter Examples
Total Response Parameters: 42 Response Parameter with Example: 42
Response Parameter without Examples
GROUP: Parameter Descriptions
Total Parameters: 20 Parameter with Description: 18
Parameter without Descriptions
- PATCH /api/groups/{id}/users - usersToAdd
- PATCH /api/groups/{id}/users - usersToRemove
GROUP: Response Parameter Descriptions
Total Response Parameters: 20 Response Parameter with Description: 20
Response Parameter without Descriptions
GROUP: Response Parameter Examples
Total Response Parameters: 20 Response Parameter with Example: 20
Response Parameter without Examples
DESTINATION: Parameter Descriptions
Total Parameters: 33 Parameter with Description: 21
Parameter without Descriptions
- POST /api/destinations - connection
- POST /api/destinations - kind
- POST /api/destinations - name
- POST /api/destinations - resources
- POST /api/destinations - roles
- POST /api/destinations - uniqueID
- POST /api/destinations - version
- PUT /api/destinations/{id} - connection
- PUT /api/destinations/{id} - resources
- PUT /api/destinations/{id} - roles
- PUT /api/destinations/{id} - uniqueID
- PUT /api/destinations/{id} - version
DESTINATION: Response Parameter Descriptions
Total Response Parameters: 52 Response Parameter with Description: 51
Response Parameter without Descriptions
- POST /api/tokens - token
DESTINATION: Response Parameter Examples
Total Response Parameters: 52 Response Parameter with Example: 50
Response Parameter without Examples
- GET /api/destinations - item.connection
- GET /api/destinations - item.version
USERS: Parameter Descriptions
Total Parameters: 27 Parameter with Description: 25
Parameter without Descriptions
- PATCH /api/groups/{id}/users - usersToAdd
- PATCH /api/groups/{id}/users - usersToRemove
USERS: Response Parameter Descriptions
Total Response Parameters: 26 Response Parameter with Description: 26
Response Parameter without Descriptions
USERS: Response Parameter Examples
Total Response Parameters: 26 Response Parameter with Example: 26
Response Parameter without Examples
PROVIDER: Parameter Descriptions
Total Parameters: 33 Parameter with Description: 17
Parameter without Descriptions
- POST /api/providers - allowedDomains
- POST /api/providers - api
- POST /api/providers - clientID
- POST /api/providers - clientSecret
- POST /api/providers - kind
- POST /api/providers - name
- POST /api/providers - url
- PUT /api/providers/{id} - allowedDomains
- PUT /api/providers/{id} - api
- PUT /api/providers/{id} - clientID
- PUT /api/providers/{id} - clientSecret
- PUT /api/providers/{id} - kind
- PUT /api/providers/{id} - name
- PUT /api/providers/{id} - url
- PATCH /api/providers/{id} - clientSecret
- PATCH /api/providers/{id} - name
PROVIDER: Response Parameter Descriptions
Total Response Parameters: 50 Response Parameter with Description: 50
Response Parameter without Descriptions
PROVIDER: Response Parameter Examples
Total Response Parameters: 50 Response Parameter with Example: 50
Response Parameter without Examples
MISC: Parameter Descriptions
Total Parameters: 0 Parameter with Description: 0
Parameter without Descriptions
MISC: Response Parameter Descriptions
Total Response Parameters: 0 Response Parameter with Description: 0
Response Parameter without Descriptions
MISC: Response Parameter Examples
Total Response Parameters: 0 Response Parameter with Example: 0
Response Parameter without Examples
SETTING: Parameter Descriptions
Total Parameters: 0 Parameter with Description: 0
Parameter without Descriptions
SETTING: Response Parameter Descriptions
Total Response Parameters: 0 Response Parameter with Description: 0
Response Parameter without Descriptions
SETTING: Response Parameter Examples
Total Response Parameters: 0 Response Parameter with Example: 0
Response Parameter without Examples
89.98384491114702% complete!