Skip to content
This repository has been archived by the owner on Aug 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #573 from NupurSancheti/dev
Browse files Browse the repository at this point in the history 
update user
  • Loading branch information
@Basreena
Basreena authored Aug 13, 2018
2 parents 38df01d + 664890f commit 5786a80
Show file tree
Hide file tree
Showing 9 changed files with 245 additions and 234 deletions.
83 changes: 43 additions & 40 deletions _includes/sidebar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ <h4 class="sidebar-group-title">Architecture</h4>
<h4 class="sidebar-group-title">Product Features</h4>
</a>
<ul class="sidebar-group features-documentation">
<li>
<a href="features-documentation/explore_sunbird/">Explore Sunbird</a>
</li>
<li>
<a href="features-documentation/login/">Sign In</a>
</li>
Expand Down Expand Up @@ -79,47 +82,47 @@ <h4 class="sidebar-group-title">Product Features</h4>
<a href="features-documentation/collection_creation/">Collection</a>
</li>
<li>
<a href="features-documentation/resource_creation/">Resource</a>
</li>
<li>
<a href="features-documentation/course_intro/">Courses</a>
</li>
<li>
<div class="">
<ul class="sidebar-group">
<li>
<a href="features-documentation/course_creation/">Course Creation</a>
</li>
<li>
<a href="features-documentation/course_batches/">Batch Creation</a>
</li>
<li>
<a href="features-documentation/course_consumption/">Taking a Course</a>
</li>
</ul>
</div>
</li>
<li>
<a href="features-documentation/upload/">Uploading Content</a>
</li>
<li>
<div class="">
<a href="features-documentation/badging_framework/badging_overview/">Badging Framework</a>
<ul class="sidebar-group">
<li>
<a href="features-documentation/badging_framework/content_badges/">Issuing Badges for Content</a>
</li>
</ul>
</div>
</li>
<li>
<a href="features-documentation/announcement/">Announcement</a>
</li>
<li>
<a href="features-documentation/content_review/">Content Review</a>
</li>
<a href="features-documentation/resource_creation/">Resource</a>
</li>
<li>
<a href="features-documentation/course_intro/">Courses</a>
</li>
<li>
<div class="">
<ul class="sidebar-group">
<li>
<a href="features-documentation/course_creation/">Course Creation</a>
</li>
<li>
<a href="features-documentation/course_batches/">Batch Creation</a>
</li>
<li>
<a href="features-documentation/course_consumption/">Taking a Course</a>
</li>
</ul>
</div>
</li>
<li>
<a href="features-documentation/upload/">Uploading Content</a>
</li>
<li>
<div class="">
<a href="features-documentation/badging_framework/badging_overview/">Badging Framework</a>
<ul class="sidebar-group">
<li>
<a href="features-documentation/badging_framework/content_badges/">Issuing Badges for Content</a>
</li>
</ul>
</div>
</li>
<li>
<a href="features-documentation/announcement/">Announcement</a>
</li>
<li>
<a href="features-documentation/content_review/">Content Review</a>
</li>
<li>
<a href="features-documentation/library/">Library</a>
<a href="features-documentation/library/">Library</a>
</li>
<li>
<a href="features-documentation/contentlifecycle/">Content Lifecycle</a>
Expand Down
87 changes: 64 additions & 23 deletions pages/developer-docs/how-to-guide/how_to_create_organization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,49 +10,90 @@ allowSearch: true
---
## Scenario

A company, XYZ Corp, is a global conglomerate with over ten thousand employees, spread across 5 locations. Employee training and enablement is one of the core values of the organization. To ensure that employees are regularly trained and upskilled, XYZ Corp has decided to use Sunbird for its learning and training solution. To give employees access to the learning platform, the organization's administrator needs to create an organization.

Sunbird identifies every tenant organization uniquely through a channel. When creating an organization, in addition, to organization details, Organization ID must be assigned. The organization ID has to be associated with an organization and a channel. For example, John is a manager in XYZ corporation, who can create, review and take courses. He is also an administrator in the system, in which capacity he can add users and assign permissions to them.

### Prerequisites
- Postman app is installed, refer [How to install and call an API using Postman]
- First Organization with channel ID
- Access API using
- Authorization header with Bearer {{api-key}}
- Organization authentication key
- Create Org API - To create an organisation and sub-organizations
- A system administrator user is created

## Overview
1.An initialized server instance of Sunbird. Initialization includes creating an org admin user (through Keycloak), creating a channel and associating a first organization with the channel.

Organizations, on Sunbird can be an institute or a body of individuals. To utilize Sunbird for organizational needs, an orgnization needs to be created on Sunbird.
For details, refer to:

create an organization account replicating the organization containing multiple employees or users and . To create an organization, the organization administrator user needs to be created under root organization. System Administrator can to generate an authorization token for creating organizations.
* [Server Installation](http://www.sunbird.org/developer-docs/installation/server_installation/)

### Taskflow
* [Channel APIs](http://www.sunbird.org/apis/framework/#tag/Channel-APIs)

* [First organization](http://www.sunbird.org/developer-docs/initialization) associated with channel ID

An organization can be created in a Sunbird instance using ORG API, it can be further associated with a user and channel, refer [Mapping User to Organization](www.sunbird.org). For creating an organization follow the steps:
2.The API Key for access and basic authentication

3.An API client to make API calls. For example use Postman refer [Using Postman] (http://www.sunbird.org/apis/framework/#tag/usingpostman)

Step | Action | Description |
-------|----------------|---------------------------------------------------------------|
1 | Authentication | Enter the Bearer {{api-key}} to pass the Authorization header |
2 |Create first Organization |To create first organization or a tenant for an installed instance on Sunbird, refer Initialize Sunbird |
3 |Credentials|Use System administrator credentials to create the following instances Root Organization New User Root Org Admin|
4 |Create root organization |Create an organisation using Org API document **Note**: To create rootOrg, pass the following attribute along with API isRootOrg : true channel : a unique string value that can be used for filtering the data|
5| Save | Save the created organization ID |
4.Access to the [Create Organization API](http://www.sunbird.org/apis/userapi/#tag/Orgs-APIs)

### Taskflow

The sequence of tasks the organization administrator follows to create users include:

1.Specify values for the following parameters in the request body of the API

An organization can be created in a Sunbird instance using ORG API, it can be further associated with a user and channel, refer [Mapping User to Organization](www.sunbird.org).
Following is an example of request body for creating a user, the sample values provided in the request body are indicative:

**Request Body**

<pre>
"request":{
"orgName":"ORG JP_1",
"description":"Dev Default Org",
"imgUrl":"N/A",
"channel":"channel -12571w1sja",
"preferredLanguage":"English",
"homeUrl":"N/A",
"orgCode":"orgCode123sd",
"isRootOrg":true,
"provider":"1231rwsadk",
"externalId":"exts12w7k",
"address":{
"city":"Bangalore",
"state":"KA",
"country":"INDIA",
"zipCode":"566666"
}
</pre>

**Response Body**

<pre>
"responseCode": "OK",
"result": {
"organisationId": "012567820191629312269",
"response": "SUCCESS"
}
</pre>

2.Save the created organization ID

3.An organization is created in Sunbird

### Concepts Covered

**Users**: The individual who can sign in and access the Sunbird portal to perform a set of action that is assigned by the system administrator.

**Organization**: Organizations can be an institute or a body of individuals.

**Channel**: Unique identification number associated with the user or an organization

**Root Organization**: All users and sub-organization in an organisation are associated through the rootOrg

**System Administrator**: A user who manages end-to-end system from creating an organization, administrators for the organizations, members within the organization, and assign roles to the members


### Additional Topics

[Creating Organization](http://www.sunbird.org)
[Creating first organization](http://www.sunbird.org/developer-docs/initialization)

[Map users to different business units within the organisation](http://www.sunbird.org)
[Creating user](http://www.sunbird.org/developer-docs/how-to-guide/how_to_create_user)

[Creating first organization](http://www.sunbird.org)
[Map users to different business units within the organisation](http://www.sunbird.org/developer-docs/how-to-guide/hohow_to_create_org_add_user)
Loading

0 comments on commit 5786a80

Please sign in to comment.