OpenID Connect (OIDC) Schemas
Copy Page
CoffeeBean APIs
OAuth
OAuth
Generate OAuth Token
Revoke OAuth Token
User
Get Current User Information
Create a new user manually
/marketing/login/users/reset_password/email
Update Current User
Unlock Current User
Get Current User Data
Update Current User Data
Device
Add new device to Login App
Relate Device to Current User
User Management APIs
User
Get all users or search for users
Find a user by identifier
Get user information
Update user information
Delete user
Get user profile
Generate new user token
Force user to be updated
Move user data to another user
Reset Password
/marketing/login/users/reset_password/token
/marketing/login/users/reset_password
Email Confirmation
/marketing/login/users/email_confirmation/email
/marketing/login/users/email_confirmation/token
User Status
/marketing/login/users/{user_id}/activate
/marketing/login/users/{user_id}/deactivate
/marketing/login/users/{user_id}/unlock
User Credentials
Get all user credentials
Add social app credential to user
Remove social app credential from user
User Data
Get user custom profile information
Update user custom profile information
User Mac Address
Create new mac address for user
Delete mac address from user
User Groups
Get user groups
User Roles
Get user roles
User Reviewable Access Requests
Get user reviewable access requests
User Authorized Login Apps
Get user authorized login apps
Facebook (Deprecated)
Post message to user Facebook timeline
Post Facebook notification to user
Get Facebook user friends
User MPact Client (Deprecated)
Create new MPact client for user
Clustering (Deprecated)
Get user clustering features
Login & Apps Management APIs
Info
Validate token and return login information
Sign ins
Returns sign in information
Creates a sign in given a user identifier
Creates a sign in given a provider credential
Creates a sign in given his password and username or e-mail
Connections
Closes a connection (logout)
Keeps the connection alive
Returns connection information
Login Apps
Searches for Login Apps
Creates a Login App
Returns a Login App
Updates a Login App
Deletes a Login App
Social Apps
Returns all Social Apps from the Login App
Clustering (Deprecated)
Returns login app clustering rules
Updates login app clustering rules
Automation Engine APIs
Triggers
Trigger an event for a Login App user
Push Notification APIs
Devices
Link device to Login App user
Push Notifications
Send push notification to device
Send push notification to all Login App devices
Send push notification to all user devices
Group Management APIs
Groups
Get groups
Create group
Get group
Update group
Delete group
Group Users
Get group users
Add user to group
Remove user from group
Group Roles
Get group roles
Add role to group
Remove role from group
Group Parents
Get group parents
Add parent group to group
Remove parent group from group
Group Children
Get group children
Group Managers
Get group managers
Add group manager
Remove group manager
Group Managees
Get managed groups
Wi-Fi APIs
Venues
Get venues status monitoring
Sign Ins
Get Wi-Fi sign ins
Create Wi-Fi sign in
Coupons
Create batch of coupons
RBAC Management APIs
Roles
Search for Roles
Create a Role
Get a Role
Update a Role
Delete a Role
Role Users
Search for Users with a Role
Add a Role to a User
Remove a Role from a User
Role Groups
Search for Groups in a Role
Access Requests
Search for Access Requests
Create an Access Request
Get an Access Request
Update an Access Request
Delete an Access Request
Access Request Comments
Search for Comments in an Access Request
Create a Comment in an Access Request
Access Request Reviews
Search for Reviews in an Access Request
Create a Review in an Access Request
Access Request Events
Search for Events in an Access Request
Access Request Reviewers
Search for Reviewers in an Access Request
Create a Reviewer for an Access Request
Remove a Reviewer from an Access Request
Datastore APIs
Schema
Get all schemas
Create a new schema
Get a specific schema
Update a schema
Remove a schema
Object
Get all objects from a schema
Create a new object
Search for objects in a schema
Get a specific object
Update an object
Remove an object
Remove all objects from a user
Multi-Factor Authentication (MFA) APIs
User
List/find users from a tenant
Creates a user
Deletes a user
Session
Authorization Request
Token Request
Finish the authorize flow
Validation
Check user validations
Factor
List all factors
Authenticator
Associate authenticator to user
Generate authenticator challenge
Validate user authenticator
List user authenticators
Delete authenticator
Login
Generate login challenge
Validate login authenticator
OpenID Connect (OIDC)
UserInfo
UserInfo Request (GET)
UserInfo Request (POST)
Session
Logout Request (GET)
Logout Request (POST)
Token
Token Revocation
Schemas
OAuth Schemas
TokenPasswordRequest
TokenProviderCredentialsRequest
TokenProviderAuthorizationCodeRequest
TokenLdapCredentialsRequest
TokenUserIdRequest
TokenClientCredentialsRequest
TokenRefreshTokenRequest
TokenRevokeRequest
DeviceResponse
UserDeviceRelation
UserResponse
TokenAppResponse
User Management APIs Schemas
UserWithProfile
UserProfile
ResetPasswordTokenRequest
UserUpdate
ResetPasswordTokenResponse
ResetPasswordEmailRequest
ResetPasswordRequest
UserDataResponse
EmailConfirmationRequest
UserDataUpdate
EmailConfirmationTokenRequest
EmailConfirmationTokenResponse
UserCredentialsResponse
UserCredential
UserCredentialCreate
MacAddressCreate
MacAddress
UserGroupsResponse
UserGroup
UserRolesResponse
UserRole
UserReviewableAccessRequestsResponse
ReviewableAccessRequest
UserAuthorizedAppsResponse
AuthorizedApp
FacebookUpdateRequest
FacebookUpdateResponse
FacebookNotificationRequest
FacebookNotificationResponse
FacebookFriendsResponse
FacebookFriend
MpactClientCreate
MpactClient
ClusteringFeaturesResponse
Login & Apps Management APIs Schemas
LoginInfoResponse
SignInResponse
SignInCreate
OAuth1ProviderCredentials
OAuth2ProviderCredentials
OIDCProviderCredentials
UserLogin
ConnectionInfoResponse
LoginApp
LoginAppsResponse
LoginAppCreate
LoginAppUpdate
SocialApp
ClusteringRules
Automation Engine APIs Schemas
TriggerEventRequest
Push Notification APIs Schemas
DeviceCreateRequest
DeviceCreateResponse
DevicePublishRequest
AppPublishRequest
UserPublishRequest
Device
DeviceCreate
Group Management APIs Schemas
GroupCreate
GroupUpdate
GroupUserCreate
GroupRolesResponse
GroupRoleCreate
GroupRole
GroupParentGroupsResponse
GroupParentGroupCreate
GroupParentGroup
GroupUsersResponse
GroupUser
GroupsResponse
GroupChildGroupsResponse
GroupChildGroup
GroupManagerGroupsResponse
GroupManagerGroup
GroupManagerGroupCreate
GroupManagedGroupsResponse
GroupManagedGroup
Wi-Fi APIs Schemas
RBAC Management APIs Schemas
RolesResponse
AccessRequestsResponse
AccessRequest
AccessRequestCreate
AccessRequestUpdate
Role
AccessRequestCommentsResponse
AccessRequestComment
AccessRequestCommentCreate
RoleCreate
RoleUpdate
LoginUser
RoleUsersResponse
RoleUser
Group
RoleUserCreate
RoleGroupsResponse
RoleGroup
AccessRequestReviewsResponse
AccessRequestReview
AccessRequestReviewCreate
AccessRequestEventsResponse
AccessRequestEvent
AccessRequestReviewersResponse
AccessRequestReviewer
AccessRequestReviewerCreate
Datastore APIs Schemas
SchemasResponse
Schema
SchemaField
CreateSchemaRequest
CreateSchemaField
SchemaPermissions
UpdateSchemaRequest
ObjectsResponse
DatastoreObject
CreateObjectRequest
SearchObjectsRequest
UpdateObjectRequest
Multi-Factor Authentication (MFA) APIs Schemas
UsersResponse
UserCreateResponse
User
TokenRequestUserId
TokenRequestUsername
UserCreate
CallbackRequest
ValidationResponse
ValidationAttempt
Factor
AuthenticatorCreate
AuthenticatorResponse
ChallengeRequest
ChallengeResponse
AuthenticatorVerify
AuthenticatorVerifyResponse
AuthenticatorDetail
LoginChallengeRequest
LoginChallengeResponse
LoginValidateRequest
LoginValidateResponse
FIDO2Challenge
FIDO2Options
FIDO2RelyingParty
FIDO2User
FIDO2PubKeyCredParam
FIDO2Credential
FIDO2AuthenticatorSelection
OpenID Connect (OIDC) Schemas
PaginatedResponse
TokenRequest
UserInfoResponse
AddressClaim
LogoutRequest
RevokeRequest
TokenResponse
ErrorResponse
DetailedError
OpenID Connect (OIDC) Schemas
Copy Page
LogoutRequest
{
"id_token_hint"
:
"string"
,
"post_logout_redirect_uri"
:
"http://example.com"
,
"state"
:
"string"
}