WebFrolic API reference

78 endpoints across 10 groups — SCIM 2.0 at site and tenant level, users, tenants, groups, applications, vault, variables and metadata. Every example is generated from the published OpenAPI 3.1.0 document, in twelve languages.

Base URL: https://b.cell.webfrolic.com
Spec: OpenAPI 3.1.0 · v0
Content type: application/json
application/scim+json
Unauthenticated: 403 Not Authorized

About this reference

WebFrolic is an enterprise identity platform — customer and workforce identity, multi-tenant organisations, RBAC and a built-in help desk. This reference documents its REST API: SCIM 2.0 user and group provisioning at both site and tenant scope, tenant and membership management, application assignment, the secrets vault, configuration variables and read-only identity metadata.

It is generated directly from the service's published OpenAPI 3.1.0 document, so paths, methods, parameters and model shapes match what the server actually exposes — nothing here is hand-written or illustrative. Each endpoint shows a runnable request in twelve languages and an example response derived from the published models. SCIM calls use application/scim+json; everything else uses application/json.

Reading vs. changing data. This page is for exploring and calling the API. To create, modify or delete the underlying configuration — applications, users, groups, tenants, vault secrets — through a guided interface, use the WebFrolic admin console.

Download Postman collection All 78 endpoints, ready to import. No CORS limits — runs outside the browser. Open the admin console → Add, modify or delete applications, users, groups and more through the UI.

Two things the published spec does not state. It records no security scheme — only that unauthenticated calls return 403 Not Authorized — so every sample here sends a bearer token as the most likely fit; change it if your deployment expects an API-key header or a session cookie. It also names ApiError and ScimError without attaching them to status codes, so the response panes show shapes derived from the published models rather than captured responses.

Bearer token (memory only): Base URL:

The token stays in page memory and is not saved to local storage or written into code samples.

Tenant SCIM Operations

Manage tenant users and groups via SCIM operations

GET /api/idp/{tenantId}/scim2/Groups

Get a list of SCIM groups for a tenant

Operation ID queryScimGroups

Parameters

Name	In	Type	Description
tenantId*	path	string	—
startIndex	query	integer (int32)	— default 1
count	query	integer (int32)	— default 30

Responses

200	Successfully retrieved a list by groups by page number if provided
400	Bad Request
403	Not Authorized
404	Group not found

POST /api/idp/{tenantId}/scim2/Groups

Create a SCIM group for tenant

Operation ID createScimGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

ScimGroupRequest — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully craete a group
400	Bad Request
403	Not Authorized
409	Record Already Exists

DELETE /api/idp/{tenantId}/scim2/Groups/{id}

Delete a SCIM group for tenant by groupId

Operation ID deleteScimGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Responses

204	No Content
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/{tenantId}/scim2/Groups/{id}

Get a tenant SCIM group by groupId

Operation ID getScimGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Responses

200	Successfully retrieved a group by groupId
400	Bad Request
403	Not Authorized
404	Group not found

PATCH /api/idp/{tenantId}/scim2/Groups/{id}

Manage the members for a SCIM group

Operation ID patchScimGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Request body

ScimGroupPatch — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully updated group memberships
400	Bad Request
403	Not Authorized
404	Group not found
409	Record Already Exists

PUT /api/idp/{tenantId}/scim2/Groups/{id}

Not Supported. Create a tenant group if it does not exists alreadt.

Operation ID upsertScimGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Request body

ScimGroup — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200

GET /api/idp/{tenantId}/scim2/Users

Query for tenant members. Filter supported for username and work email

Operation ID queryUser

Parameters

Name	In	Type	Description
tenantId*	path	string	—
filter	query	string	—
startIndex	query	integer (int32)	— default 1
count	query	integer (int32)	— default 30

Responses

200	Successfully retrieved a list by groups by page number if provided
400	Bad Request
403	Not Authorized
404	Group not found

POST /api/idp/{tenantId}/scim2/Users

Creates a tenant member

Operation ID createUser

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

ScimUser — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully created a User
400	Bad Request
403	Not Authorized
404	User not found
409	User Already Exists

DELETE /api/idp/{tenantId}/scim2/Users/{id}

Deletes a tenant member

Operation ID deleteUser

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Responses

204	Successfully deleted a User
400	Bad Request
403	Not Authorized
404	User not found

GET /api/idp/{tenantId}/scim2/Users/{id}

Get a tenant member

Operation ID get

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Responses

200	Successfully retrieved a User by userId
400	Bad Request
403	Not Authorized
404	User not found

PUT /api/idp/{tenantId}/scim2/Users/{id}

Update a tenant member

Operation ID updateUser

Parameters

Name	In	Type	Description
tenantId*	path	string	—
id*	path	string	—

Request body

ScimUser — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Updates a SCIM User
400	Bad Request
403	Not Authorized
404	User not found

Vault Operations

Manage Vault secrets and OAuth Credentials

DELETE /api/idp/vault

Deletes a secret

Operation ID deleteSecret

Parameters

Name	In	Type	Description
secretName*	query	string	Required parameter

Responses

204	Secret Deleted Successfully
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/vault

Create a plain secret

Operation ID createSecret

Request body

VaultSecret — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Secret Created Successfully
400	Bad Request
403	Not Authorized

PUT /api/idp/vault

Updates a plain secret

Operation ID updateSecret

Request body

VaultSecret — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Secret Updated Successfully
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/vault/oauth

Create a secret to store OAuth2 Credentials

Operation ID createOAuthSecret

Request body

VaultOAuthSecret — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Secret Created Successfully
400	Bad Request
403	Not Authorized

PUT /api/idp/vault/oauth

Updates a secret for OAuth2 Credentials

Operation ID updateOAuthSecret

Request body

VaultOAuthSecret — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Secret Updated Successfully
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/vault/query

Query secret by name

Operation ID getSecretValue

Parameters

Name	In	Type	Description
secretName*	query	string	Required parameter

Responses

200	Returns the secret value if its plain secret, or returns the Access Token if its an OAuth Credential
400	Bad Request
403	Not Authorized

Variable Operations

Manage Configuration Variables

DELETE /api/idp/variable

Deletes a variable

Operation ID deleteVariable

Parameters

Name	In	Type	Description
variableName*	query	string	Required parameter

Responses

204	variable Deleted Successfully
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/variable

Create a variable

Operation ID createVariable

Request body

Variable — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Variable Created Successfully
400	Bad Request
403	Not Authorized

PUT /api/idp/variable

Updates a variable

Operation ID updateVariable

Request body

Variable — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Variable Updated Successfully
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/variable/query

Query variable by name

Operation ID getVariableValue

Parameters

Name	In	Type	Description
variableName*	query	string	Required parameter

Responses

200	Returns the variable value
400	Bad Request
403	Not Authorized

User API Operations

Manage User

GET /api/idp/user

Retrieve users in paginated manner. Filters for email and user type supported

Operation ID getUser_1

Parameters

Name	In	Type	Description
email	query	string	Optional parameter, allows to filter user by email address
category	query	string	Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE default customer
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25

Responses

200	Successfully retrieved a list by users by page number if provided
400	Bad Request
403	Not Authorized

POST /api/idp/user

Create user record

Operation ID createUser_1

Parameters

Name	In	Type	Description
userType	query	string	Optional parameter, defaults to Regular. Supported Values SERIVCE, TEST, REGULAR default REGULAR
category	query	string	Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE default customer

Request body

User — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	User Created Successfully
400	Bad Request
403	Not Authorized

DELETE /api/idp/user/{customerId}/session/{sessionId}

Delete a User Session

Operation ID getSchema

Parameters

Name	In	Type	Description
customerId*	path	string	—
sessionId*	path	string	—

Responses

204	Session Deleted
400	Bad Request
403	Not Authorized
404	User session not found

GET /api/idp/user/{customerId}/session/{sessionId}

Retrieve a User Session

Operation ID getSession

Parameters

Name	In	Type	Description
customerId*	path	string	—
sessionId*	path	string	—

Responses

200	Returns a User session by sessionId
400	Bad Request
403	Not Authorized
404	User session not found

POST /api/idp/user/{customerId}/session/{sessionId}

Update User Session

Operation ID updateSession

Parameters

Name	In	Type	Description
customerId*	path	string	—
sessionId*	path	string	—

Responses

204	Session Updated
400	Bad Request
403	Not Authorized
404	User session not found

DELETE /api/idp/user/{userId}

Deletes user by userId

Operation ID deleteUser_1

Parameters

Name	In	Type	Description
userId*	path	string	—

Responses

200	User Deleted Successfully
400	Bad Request
403	Not Authorized

GET /api/idp/user/{userId}

Retrieves a user for a given userId

Operation ID getUser

Parameters

Name	In	Type	Description
userId*	path	string	—

Responses

200	User retrieved Successfully
400	Bad Request
403	Not Authorized

PUT /api/idp/user/{userId}

Updates a user record

Operation ID updateUser_1

Parameters

Name	In	Type	Description
userId*	path	string	—

Request body

User — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	User Updated Successfully
400	Bad Request
403	Not Authorized

Tenant Operations

Manage Tenants, tenant Groups and Memberships

GET /api/idp/tenant

Retrieve tenant list

Operation ID getTenant_1

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25

Responses

200	Successfully retrives the tenant list
400	Bad Request
403	Not Authorized

POST /api/idp/tenant

Create a Tenant

Operation ID createTenant

Parameters

Name	In	Type	Description
member	query	boolean	Optional boolean parameter, add the callee as a tenant member and owner if set to true default False
defaultRole	query	string	Optional parameter, assigns the given role to the callee if the tenant role exists

Request body

Tenant — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Tenant Created Successfully
400	Bad Request
403	Not Authorized

DELETE /api/idp/tenant/{tenantId}

Delete a Tenant

Operation ID deleteTenant

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Responses

204	Tenant Deleted Successfully
400	Bad Request
403	Not Authorized

GET /api/idp/tenant/{tenantId}

Retrieves a Tenant

Operation ID getTenant

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Responses

200	Returns Tenant if exists
400	Bad Request
403	Not Authorized
404	Not Found

PUT /api/idp/tenant/{tenantId}

Update a Tenant

Operation ID updateTenant

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

Tenant — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Tenant Updated Successfully
400	Bad Request
403	Not Authorized

GET /api/idp/tenant/{tenantId}/group

Retrieve tenant group list

Operation ID getGroup_2

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25
tenantId*	path	string	—

Responses

200	Successfully retrives the group list
400	Bad Request
403	Not Authorized
404	Group not found

POST /api/idp/tenant/{tenantId}/group

Create a tenant group

Operation ID createGroup

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

TenantGroup — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Successfully created the group
400	Bad Request
403	Not Authorized
404	Group not found

DELETE /api/idp/tenant/{tenantId}/group/{groupId}

Delete a tenant group by groupId

Operation ID deleteGroup

Parameters

Name	In	Type	Description
groupId*	path	string	—
tenantId*	path	string	—

Responses

204	Successfully deleted the group
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/tenant/{tenantId}/group/{groupId}

Get a Tenant group by groupId

Operation ID getGroup

Parameters

Name	In	Type	Description
groupId*	path	string	—
tenantId*	path	string	—

Responses

200	Successfully retrieved a group by groupId
400	Bad Request
403	Not Authorized
404	Group not found

PUT /api/idp/tenant/{tenantId}/group/{groupId}

Update a tenant group by groupId

Operation ID updateGroup

Parameters

Name	In	Type	Description
groupId*	path	string	—
tenantId*	path	string	—

Request body

TenantGroup — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully updated the group
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/tenant/{tenantId}/group/{groupId}/member

Retrieve tenant group members

Operation ID getTenantGroupMembers

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
groupId*	path	string	—
memberId	query	string	—
tenantId*	path	string	—

Responses

200	Returns list of group members
400	Bad Request
403	Not Authorized

POST /api/idp/tenant/{tenantId}/group/{groupId}/member

Assign tenant Group membership to user

Operation ID createTenantGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—
tenantId*	path	string	—

Request body

GroupMember — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Creates Group membership
400	Bad Request
403	Not Authorized
422	Assignment Already Exists

DELETE /api/idp/tenant/{tenantId}/group/{groupId}/member/{membershipId}

Deletes tenant group member

Operation ID deleteTenantGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—
membershipId*	path	string	—
tenantId*	path	string	—

Responses

204	Group member Deleted
400	Bad Request
403	Not Authorized

GET /api/idp/tenant/{tenantId}/group/{groupId}/member/{membershipId}

Retrieve a tenant group member

Operation ID getTenantGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—
membershipId*	path	string	—
tenantId*	path	string	—

Responses

200	Returns Group member
400	Bad Request
403	Not Authorized
404	Not Found

POST /api/idp/tenant/{tenantId}/member

Creates a tenant member

Operation ID createTenantMember

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

TenantMember — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Successfully created a tenant member
400	Bad Request
403	Not Authorized
409	Tenant member Already Exists

POST /api/idp/tenant/{tenantId}/member/invite

Invite a user as a tenant member

Operation ID createTenantMemberByInvite

Parameters

Name	In	Type	Description
tenantId*	path	string	—

Request body

TenantMember — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Invite created Successfully
400	Bad Request
403	Not Authorized
409	Tenant member Already Exists

DELETE /api/idp/tenant/{tenantId}/member/{memberId}

Delete a tenant member

Operation ID deleteTenantMember

Parameters

Name	In	Type	Description
memberId*	path	string	—
tenantId*	path	string	—

Responses

204	Tenant membership deleted
400	Bad Request
403	Not Authorized

GET /api/idp/tenant/{tenantId}/member/{memberId}

Query for a tenant member

Operation ID getTenantMember

Parameters

Name	In	Type	Description
memberId*	path	string	—
tenantId*	path	string	—

Responses

200	Returns tenant member
400	Bad Request
403	Not Authorized
404	Not Found

PUT /api/idp/tenant/{tenantId}/member/{memberId}

Updates a tenant member

Operation ID updateTenantMember

Parameters

Name	In	Type	Description
tenantId*	path	string	—
memberId*	path	string	—

Request body

TenantMember — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully updated a Tenant Member
400	Bad Request
403	Not Authorized
409	Tenant member Already Exists

IDP SCIM Operations

Manage IDP users and groups via SCIM operations

GET /api/idp/scim2/Groups

End point to retrieve list of Groups

Operation ID queryUser_2

Parameters

Name	In	Type	Description
startIndex	query	integer (int32)	— default 1
count	query	integer (int32)	— default 30

Responses

200	Successfully retrieved a list by groups by page number if provided
400	Bad Request
403	Not Authorized
404	Group not found

DELETE /api/idp/scim2/Groups/{id}

Delete a Group by GroupId

Operation ID deleteUser_3

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

204	No Content
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/scim2/Groups/{id}

Get a SCIM group by groupId

Operation ID get_2

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200	Successfully retrieved a group by groupId
400	Bad Request
403	Not Authorized
404	Group not found

PATCH /api/idp/scim2/Groups/{id}

Update group members for a groub by Id

Operation ID patchGroup

Parameters

Name	In	Type	Description
id*	path	string	—

Request body

ScimGroupPatch — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully updated group memberships
400	Bad Request
403	Not Authorized
404	Group not found
409	Record Already Exists

PUT /api/idp/scim2/Groups/{id}

Not Supported. Create a Group

Operation ID upsertGroup

Parameters

Name	In	Type	Description
id*	path	string	—

Request body

ScimGroup — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200

GET /api/idp/scim2/Users

Endpoint to query SCIM users. Users can be filtered based of the username or work email

Operation ID queryUser_1

Parameters

Name	In	Type	Description
filter	query	string	—
startIndex	query	integer (int32)	— default 1
count	query	integer (int32)	— default 30

Responses

200	Successfully retrieved a list by groups by page number if provided
400	Bad Request
403	Not Authorized
404	Group not found

POST /api/idp/scim2/Users

Create a SCIM User

Operation ID createUser_2

Request body

ScimUser — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully created a User
400	Bad Request
403	Not Authorized
404	User not found
409	User Already Exists

DELETE /api/idp/scim2/Users/{id}

Delete a SCIM user by userId

Operation ID deleteUser_2

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

204	Successfully deleted a User
400	Bad Request
403	Not Authorized
404	User not found

GET /api/idp/scim2/Users/{id}

Get a SCIM user by userId

Operation ID get_1

Parameters

Name	In	Type	Description
id*	path	string	—

Responses

200	Successfully retrieved a User by userId
400	Bad Request
403	Not Authorized
404	User not found

PUT /api/idp/scim2/Users/{id}

Update a SCIM user by userId

Operation ID upsertUser

Parameters

Name	In	Type	Description
id*	path	string	—

Request body

ScimUser — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully update a User by userId
400	Bad Request
403	Not Authorized
404	User not found

Group Operations

Manage Groups and groups memberships

GET /api/idp/group

Retrieve group list

Operation ID getGroup_3

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25

Responses

200	Successfully retrives the group list
400	Bad Request
403	Not Authorized
404	Group not found

POST /api/idp/group

Create a group

Operation ID createGroup_1

Request body

Group — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Successfully created the group
400	Bad Request
403	Not Authorized
404	Group not found

DELETE /api/idp/group/{groupId}

Delete a group by groupId

Operation ID deleteGroup_1

Parameters

Name	In	Type	Description
groupId*	path	string	—

Responses

204	Successfully deleted group
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/group/{groupId}

Get a group by groupId

Operation ID getGroup_1

Parameters

Name	In	Type	Description
groupId*	path	string	—

Responses

200	Successfully retrieved a group by groupId
400	Bad Request
403	Not Authorized
404	Group not found

PUT /api/idp/group/{groupId}

Update a group by groupId

Operation ID updateGroup_1

Parameters

Name	In	Type	Description
groupId*	path	string	—

Request body

Group — the sample is generated from the published model, so fields you do not need can be removed.

Responses

200	Successfully updated the group
400	Bad Request
403	Not Authorized
404	Group not found

GET /api/idp/group/{groupId}/member

Retrieve group members

Operation ID getGroupMembers

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25
groupId*	path	string	—
memberId	query	string	—

Responses

200	Returns list of group members
400	Bad Request
403	Not Authorized

POST /api/idp/group/{groupId}/member

Assign Group membership to user

Operation ID createGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—

Request body

GroupMember — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Creates Group membership
400	Bad Request
403	Not Authorized
422	Assignment Already Exists

DELETE /api/idp/group/{groupId}/member/{membershipId}

Deletes group member

Operation ID deleteGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—
membershipId*	path	string	—

Responses

204	Group member Deleted
400	Bad Request
403	Not Authorized

GET /api/idp/group/{groupId}/member/{membershipId}

Retrieve group member

Operation ID getGroupMember

Parameters

Name	In	Type	Description
groupId*	path	string	—
membershipId*	path	string	—

Responses

200	Returns Group member
400	Bad Request
403	Not Authorized
404	Not Found

Application

List and Manage Application Assignments

GET /api/idp/application

List all the applications

Operation ID getApplication

Parameters

Name	In	Type	Description
type	query	string	Optional parameter for filtering applications by type. Supported Values SAML, OIDC_CLIENT, OIDC_SERVER, OAUTH2_CLIENT, OAUTH2_SERVER, OAUTH2_CLIENTCRED
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25

Responses

200	Returns list of applications
400	Bad Request
403	Not Authorized

GET /api/idp/application/{applicationId}/assignment

Retrieve application assignments

Operation ID getApplicationAssignees

Parameters

Name	In	Type	Description
pageNumber	query	integer (int32)	— default 0
pageSize	query	integer (int32)	— default 25
applicationId*	path	string	—

Responses

200	Returns list of application assignments
400	Bad Request
403	Not Authorized

POST /api/idp/application/{applicationId}/assignment

Creates application assignment

Operation ID createApplicationAssignment

Parameters

Name	In	Type	Description
applicationId*	path	string	—

Request body

ApplicationAssignment — the sample is generated from the published model, so fields you do not need can be removed.

Responses

201	Creates Application Assignment
400	Bad Request
403	Not Authorized
422	Assignment Already Exists

DELETE /api/idp/application/{applicationId}/assignment/{assignmentId}

Deletes application assignment

Operation ID deleteApplicationAssignment

Parameters

Name	In	Type	Description
applicationId*	path	string	—
assignmentId*	path	string	—

Responses

204	Application Assignment Deleted
400	Bad Request
403	Not Authorized

GET /api/idp/application/{applicationId}/assignment/{assignmentId}

Retrieve application assignment

Operation ID getApplicationAssignee

Parameters

Name	In	Type	Description
applicationId*	path	string	—
assignmentId*	path	string	—

Responses

200	Returns application Assignment
400	Bad Request
403	Not Authorized

Meta Data APIs

Query and list roles, scopes, and user schema

GET /api/idp/role

Retrieves list of roles

Operation ID getRoles

Parameters

Name	In	Type	Description
type	query	string	Optional parameter, defaults to GLOBAL. Supported Values GROBAL, RESOURCE default GLOBAL

Responses

200	Returns the list of roles
400	Bad Request
403	Not Authorized

GET /api/idp/scope

Retrieves scopes

Operation ID getScopes

Parameters

Name	In	Type	Description
namespace	query	string	Optional parameter, Allows to filter scopes for a particular namespace

Responses

200	Returns the list of scopes
400	Bad Request
403	Not Authorized

GET /api/idp/scope/{scopeName}

Retrieves scope details for a scope

Operation ID getScopeDetail

Parameters

Name	In	Type	Description
scopeName*	path	string	—

Responses

200	Returns the details including the resource and permissions assigned to scope
400	Bad Request
403	Not Authorized
404	Not Authorized

GET /api/idp/user/schema

Retrieves user schema for a given user category

Operation ID getSchema_1

Parameters

Name	In	Type	Description
category	query	string	Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE default customer

Responses

200	Returns the list of user attributes for a given user category
400	Bad Request
403	Not Authorized

GET /api/idp/{resourceId}/role

Retrieves list of roles

Operation ID getResourceRoles

Parameters

Name	In	Type	Description
resourceId*	path	string	—

Responses

200	Returns the list of roles for a given resourceId
400	Bad Request
403	Not Authorized

Test Automation

Query the Email or SMS OTP code for Test Users

GET /api/idp/user/test/otp

Query a OTP code for Test User

Operation ID getTestUserOtp

Parameters

Name	In	Type	Description
email	query	string	Optional parameter
phone	query	string	Optional parameter

Responses

200	OPT code
400	Bad Request
403	Not Authorized