ortelius-ms-validate-user

Environments to Applications report microservices

Version 0.1.0

ortelius-ms-validate-user

Path Table

Method	Path	Description
GET	/health	Health
GET	/msapi/validateuser	Validateuser
GET	/loginhelp	Get Login Help Page
POST	/forgot-username	Forgot Username
POST	/forgot-password	Forgot Password
GET	/reset-password	Get Reset Password Page
POST	/reset-password	Reset Password

Reference Table

Name	Path	Description
DomainList	#/components/schemas/DomainList
ForgotPasswordPayload	#/components/schemas/ForgotPasswordPayload
ForgotUsernamePayload	#/components/schemas/ForgotUsernamePayload
HTTPValidationError	#/components/schemas/HTTPValidationError
Message	#/components/schemas/Message
ResetPasswordPayload	#/components/schemas/ResetPasswordPayload
StatusMsg	#/components/schemas/StatusMsg
ValidationError	#/components/schemas/ValidationError

Path Details

---

[GET]/health

• Summary
  Health

Responses

• 200 Successful Response

application/json

{
  status?: string
  service_name?: string
}

---

[GET]/msapi/validateuser

• Summary
  Validateuser

Parameters(Query)

domains?: Partial(string) & Partial(null)

Responses

• 200 Successful Response

application/json

{
  domains?: integer[]
}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[GET]/loginhelp

• Summary
  Get Login Help Page

Responses

• 200 Successful Response

text/html

{
  "type": "string"
}

---

[POST]/forgot-username

• Summary
  Forgot Username

RequestBody

• application/json

{
  email: string
}

Responses

• 200 Successful Response

application/json

{
  detail?: string
}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[POST]/forgot-password

• Summary
  Forgot Password

RequestBody

• application/json

{
  username: string
}

Responses

• 200 Successful Response

application/json

{
  detail?: string
}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[GET]/reset-password

• Summary
  Get Reset Password Page

Parameters(Query)

token: string

Responses

• 200 Successful Response

text/html

{
  "type": "string"
}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[POST]/reset-password

• Summary
  Reset Password

RequestBody

• application/json

{
  token: string
  new_password: string
}

Responses

• 200 Successful Response

application/json

{
  detail?: string
}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

References

#/components/schemas/DomainList

{
  domains?: integer[]
}

#/components/schemas/ForgotPasswordPayload

{
  username: string
}

#/components/schemas/ForgotUsernamePayload

{
  email: string
}

#/components/schemas/HTTPValidationError

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

#/components/schemas/Message

{
  detail?: string
}

#/components/schemas/ResetPasswordPayload

{
  token: string
  new_password: string
}

#/components/schemas/StatusMsg

{
  status?: string
  service_name?: string
}

#/components/schemas/ValidationError

{
  loc?: Partial(string) & Partial(integer)[]
  msg: string
  type: string
}