Setting Policies for an Organization

Organization administrators can do any one of the following actions:

• Set policies for their organization.
• Update their organization's policies.

To learn more about the types of policies that can be configured, see Policy Architecture.

note

1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
2. Log in using {{url}}/user/v1/account/login to generate an access_token.

HTTP Request

Method: POST

{{url}}/mentoring/v1/org-admin/setOrgPolicies

Request Body

Payload Parameter	Data Type	Description	Required
session_visibility_policy	String	Manage whether your organization’s sessions should be visible to users from other organizations. Manage whether your organization’s mentees should be visible to session managers from other organizations. Valid values: ALL CURRENT ASSOCIATED	True
mentor_visibility_policy	String	Manage whether your organization’s mentors should be visible to users from other organizations. Valid values: ALL CURRENT ASSOCIATED	True
external_session_visibility_policy	String	Manage whether your organization’s users can view sessions of other organizations. Manage whether your organization’s session managers can view mentees of other organizations. Valid values: ALL CURRENT ASSOCIATED	True
external_mentor_visibility_policy	String	Manage whether your organization’s users can view mentors from other organizations. Valid values: ALL CURRENT ASSOCIATED	True
allow_mentor_override	Boolean	Specify the value as false as this key is not supported in the current version.	True

Request Header

Key	Value	Description	Required
X-auth-token	bearer {{access_token}}	The access_token received from the login response.	True
accept-language	{{hi}}	The response obtained will be in Hindi. If not provided, the response will be in English (default).	False

Response

If successful, this method returns 200 OK response code.

Response Parameters	Data Type	Description
responseCode	String	A success response.
message	String	A success message.
result	Object	Information such as the organization ID and the policies configured for the organization. The feedback forms configured for an organization in the mentee_feedback_question_set and mentor_feedback_question_set keys.
meta	Object	The API request ID in the correlation key. The meetingPlatform key specifies if the BigBlueButton meeting platform is enabled.

Viewing Policies Configured for an Organization

Organization administrators can view the list of policies configured for their organization.

note

1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
2. Log in using {{url}}/user/v1/account/login to generate an access_token.

HTTP Request

Method: POST

{{url}}/mentoring/v1/org-admin/getOrgPolicies

Request Body

This method does not require a request body.

Request Header

Key	Value	Description	Required
X-auth-token	bearer {{access_token}}	The access_token received from the login response.	True
accept-language	{{hi}}	The response obtained will be in Hindi. If not provided, the response will be in English (default).	False

Response

If successful, this method returns 200 OK response code.

Response Parameters	Data Type	Description
responseCode	String	A success response.
message	String	A success message.
result	Object	Information such as the organization ID and the policies configured for the organization. Feedback forms configured for an organization in the mentee_feedback_question_set and mentor_feedback_question_set keys.
meta	Object	The API request ID in the correlation key. The meetingPlatform key specifies if the BigBlueButton meeting platform is enabled.