Overview

Version information

Version : 1.0.0

URI scheme

Host : cloudentity.dev.cloudentity.com
BasePath : /api
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

GET /bruteforce/config

Description

Returns information about brute force configuration.

Responses

HTTP Code Description Schema

200

Response details:

BruteForceConfigResponse

400

Response details:

  • Code : Message

  • Request.Invalid: The request could not be understood by the server due to malformed syntax.

Error

401

Response details:

  • Code : Message

  • Authentication.Unauthenticated: Not authenticated. This API is only available for authenticated users.

Error

403

Response details:

  • Code : Message

  • Authorization.Unauthorized: Not authorized. This API is only available for authorized users.

Error

Tags

  • bruteforce

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

GET /bruteforce/{apiSignature}/user/{identifier}

Description

Returns information about user failed attempts for a given api.

Parameters

Type Name Description Schema

Path

apiSignature
required

Api signature.

Examples: * identifierPassword

string

Path

identifier
required

Unique identifier of a user.

Examples: * uid::joedoe@test.orchis.io will search by the provided uid

string

Responses

HTTP Code Description Schema

200

Response details:

FailedAttemptsStatus

400

Response details:

  • Code : Message

  • Request.Invalid: The request could not be understood by the server due to malformed syntax.

Error

401

Response details:

  • Code : Message

  • Authentication.Unauthenticated: Not authenticated. This API is only available for authenticated users.

Error

403

Response details:

  • Code : Message

  • Authorization.Unauthorized: Not authorized. This API is only available for authorized users.

Error

404

Response details:

  • Code : Message

  • User.NotFound: User with the given ID does not exist

  • ApiSignature.NotFound: Api with the given signature does not exist

Error

Tags

  • bruteforce

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

DELETE /bruteforce/{apiSignature}/user/{identifier}

Description

Deletes information about user failed attempts for a given api.

Parameters

Type Name Description Schema

Path

apiSignature
required

Api signature.

Examples: * identifierPassword

string

Path

identifier
required

Unique identifier of a user.

Examples: * uid::joedoe@test.orchis.io will search by the provided uid

string

Responses

HTTP Code Description Schema

204

Failed login attempts deleted successfully.

No Content

400

Response details:

  • Code : Message

  • Request.Invalid: The request could not be understood by the server due to malformed syntax.

Error

401

Response details:

  • Code : Message

  • Authentication.Unauthenticated: Not authenticated. This API is only available for authenticated users.

Error

403

Response details:

  • Code : Message

  • Authorization.Unauthorized: Not authorized. This API is only available for authorized users.

Error

404

Response details:

  • Code : Message

  • User.NotFound: User with the given ID does not exist

  • ApiSignature.NotFound: Api with the given signature does not exist

Error

Tags

  • bruteforce

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

DELETE /bruteforce/{apiSignature}/users

Description

Deletes information about failed attempts for a given api for all users.

Parameters

Type Name Description Schema

Path

apiSignature
required

Api signature.

Examples: * identifierPassword

string

Responses

HTTP Code Description Schema

204

Failed login attempts deleted successfully.

No Content

400

Response details:

  • Code : Message

  • Request.Invalid: The request could not be understood by the server due to malformed syntax.

Error

401

Response details:

  • Code : Message

  • Authentication.Unauthenticated: Not authenticated. This API is only available for authenticated users.

Error

403

Response details:

  • Code : Message

  • Authorization.Unauthorized: Not authorized. This API is only available for authorized users.

Error

404

Response details:

  • Code : Message

  • User.NotFound: User with the given ID does not exist

  • ApiSignature.NotFound: Api with the given signature does not exist

Error

Tags

  • bruteforce

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

Definitions

BruteForceConfigResponse

Name Schema

apiSignatures
optional

< string > array

Error

Name Description Schema

code
optional

Unique internal error code

string

details
optional

Optional. Varies depending on the specific use case - details are determined by the particular API call.

object

message
optional

Description of the error code

string

FailedAttemptsStatus

Name Description Schema

blocked
optional

Whether as user has been locked out.

boolean

failedAttempts
optional

< failedAttempts > array

failedAttempts

Name Description Schema

blocked
optional

Whether a user has been locked out for a particular login process.

boolean

timestamp
optional

Epoch time of failed login attempt.

number

Security

oauth2_implicit

Type : oauth2
Flow : implicit
Token URL : https://cloudentity.dev.cloudentity.com/oauth/authorize

oauth2_authorizationCode

Type : oauth2
Flow : accessCode
Token URL : https://cloudentity.dev.cloudentity.com/oauth/authorize
Token URL : https://cloudentity.dev.cloudentity.com/oauth/token

oauth2_password

Type : oauth2
Flow : password
Token URL : https://cloudentity.dev.cloudentity.com/oauth/token

SsoToken

Type : apiKey
Name : token
In : HEADER