Admin API
>
API Reference
>
v0
>
Consumers
>
Status
openapi: 3.0.0
info:
description: >-
These endpoints allow for getting the status of a user, as well as unlocking them.
version: 1.0.0
title: Consumer Status
contact:
name: team-discovery
servers:
- url: 'https://banno.com'
tags:
- name: Status
paths:
'/a/consumer-status/api/v0/users/{userId}/status':
get:
summary: Get the status of a user.
description: Requires the "View" permission for People
security:
- clientCredentials: []
tags:
- Status
parameters:
- name: userId
in: path
required: true
description: Banno User ID
schema:
$ref: '#/components/schemas/ConsumerUserId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetStatusResponseV0'
'401':
description: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetStatusForbidden'
'404':
description: Not Found
'500':
description: Internal Service Error
'/a/consumer-status/api/v0/users/{userId}/status/locked':
put:
summary: >-
Set the locked status of a user. Presently the API only supports an
unlock.
description: Requires the "Manage everything – users, messages & settings" permission
security:
- clientCredentials: []
tags:
- Status
parameters:
- name: userId
in: path
required: true
description: Banno Consumer User ID
schema:
$ref: '#/components/schemas/ConsumerUserId'
responses:
'202':
description: >-
Accepted. The unlock attempt took place when the SymX Core is in
Memo Mode. As a result, the unlock attempt has been queued and will
take effect after Memo Mode has completed.
'204':
description: NoContent
'400':
description: HTTP Request's payload does not match JSON contract.
'401':
description: Unauthorized
'404':
description: Not Found
'409':
description: Not Locked
'422':
description: Lock Attempt ('true' specified)
'500':
description: Internal Service Error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutLockedRequest_V1'
required: true
components:
securitySchemes:
clientCredentials:
type: oauth2
description: OAuth2 using the client credentials flow
flows:
clientCredentials:
tokenUrl: https://banno.com/a/oidc-provider/api/v0/token
scopes: {}
schemas:
ConsumerUserId:
type: string
format: uuid
description: A Banno Consumer User.
GetStatusResponseV0:
type: object
required:
- status
properties:
status:
type: string
enum:
- Normal
- PasswordReset
- Locked
- Disabled
- Dormant
- Pending
- PermanentlyFrozen
GetStatusForbidden:
type: object
required:
- error
properties:
error:
type: string
enum:
- WrongPassword
description: >-
WrongPassword - Banno does not have the user's correct password
stored in its layer, so it's not able to get the status of a user.
Until the user updates their password, the API is not able to get
the status of the user.
PutLockedRequest_V1:
type: object
required:
- state
properties:
state:
type: boolean
2022-12-21
Removed heldStatus from the GET /v0/users/{userId}/status endpoint since we don’t expose that today.
Added new statuses Disabled and Pending to the enum returned by the GET /v0/users/{userId}/status endpoint.
Removed NotFound, StatusCheckNotEnabled, and WrongPassword from the enum returned by the GET /v0/users/{userId}/status endpoint.
Changed the contact to team-discovery.
2022-09-14
Updated GET /v0/users/{userId}/status endpoint to include the heldStatus of a user.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.