Skip to content

Commit

Permalink
Update IdpGlobal.php
Browse files Browse the repository at this point in the history 
added custom field `division` and `district` support
  • Loading branch information
@kalyan312
kalyan312 authored Jun 20, 2022
1 parent 0cd7c75 commit e06110a
Showing 1 changed file with 132 additions and 114 deletions.
246 changes: 132 additions & 114 deletions src/SDK/Wso2Idp/IdpGlobal.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,58 @@ public function __construct($apiUrl, $apiUsername, $apiPassword, $enabledDebug)
$this->enabledDebug = $enabledDebug;
}

public function getAPIUsername(){
public function getAPIUsername()
{
return $this->apiUsername;
}
public function getAPIPassword(){

public function getAPIPassword()
{
return $this->apiPassword;
}
public function isEnabledDebug(){

public function isEnabledDebug()
{
return $this->enabledDebug;
}

public function endpointUserInfo($userID){
return $this->apiUrl . '/scim2/Users/'.$userID;
public function endpointUserInfo($userID)
{
return $this->apiUrl . '/scim2/Users/' . $userID;
}

public function endpointUserCreate(){
public function endpointUserCreate()
{
return $this->apiUrl . '/scim2/Users';
}

public function endpointUserUpdate($userID){
public function endpointUserUpdate($userID)
{
return $this->apiUrl . '/scim2/Users/' . $userID;
}

public function endpointUserPasswordReset(){
public function endpointUserPasswordReset()
{
return $this->apiUrl . '/scim2/Me';
}

public function endpointUserFiltering($args){
public function endpointUserFiltering($args)
{
$pageNo = $args['page'] ?? 1;
$countPerPage = $args['count'] ?? 10;
$filter = null;
if(isset($args['filter'])){
if (isset($args['filter'])) {
$filter .= '&filter=' . $args['filter'];
}
if(isset($args['filter']) && isset($args['excludedAttributes']) ){
if (isset($args['filter']) && isset($args['excludedAttributes'])) {
$filter .= '&excludedAttributes=' . $args['excludedAttributes'];
}
if(isset($args['filter']) && isset($args['attributes']) ){
if (isset($args['filter']) && isset($args['attributes'])) {
$filter .= '&attributes=' . $args['attributes'];
}
$startFrom = ($pageNo -1) * $countPerPage;
$startFrom = ($pageNo - 1) * $countPerPage;

return $this->apiUrl .'/scim2/Users?startIndex=' . $startFrom . '&count=' . $countPerPage.$filter;
return $this->apiUrl . '/scim2/Users?startIndex=' . $startFrom . '&count=' . $countPerPage . $filter;
}

/**
Expand All @@ -72,80 +82,84 @@ public function endpointUserFiltering($args){
* @param false $status
* @return array
*/
public function response($message, $data = [], $code = 422, $status = false){
return [
'status' => $status,
'code' => $code,
'message' => $message,
'data' => $data
];
public function response($message, $data = [], $code = 422, $status = false)
{
return [
'status' => $status,
'code' => $code,
'message' => $message,
'data' => $data
];
}

/**
* @param $message
* @param array $data
* @param int $code
* @param false $status
* @return array
*/
public function prepareResponse(Response $response, array $data = [], $customMessage = null){
$message = 'Operation Successful.';
$responseData = $data;
public function prepareResponse(Response $response, array $data = [], $customMessage = null)
{
$message = 'Operation Successful.';
$responseData = $data;

if($response->serverError() || $response->clientError()){
$message = 'Operation Not Successful.';
}
if($response->serverError()){
$message = 'Internal Idp Server Error, Please chaeck your payload and request carefully.';
}
if($response->serverError() || $response->clientError()){

$responseArray = $response->json();

if(isset($responseArray['detail']) && !empty($responseArray['detail'])){
$message = $responseArray['detail'];
}else if(isset($responseArray['scimType']) && !empty($responseArray['scimType'])){
$message = $responseArray['scimType'];
} else {
if(isset($responseArray['schemas']) && is_array($responseArray['schemas'])){
$message = implode(", ", $responseArray['schemas'] );
} else if (isset($responseArray['schemas']) && !is_array($responseArray['schemas'])){
$message = $responseArray['schemas'];
}
}
$this->logInfo($message, [
'body' => $response->body(),
'collect' => $response->collect(),
'status_code' => $response->status(),
'is_response_200' => $response->ok(),
'is_successful' => $response->successful(),
'is_failed' => $response->failed() ,
'is_serverError' => $response->serverError() ,
'is_clientErro' => $response->clientError(),
'headers' => $response->headers(),
]);
if ($response->serverError() || $response->clientError()) {
$message = 'Operation Not Successful.';
}
if ($response->serverError()) {
$message = 'Internal Idp Server Error, Please chaeck your payload and request carefully.';
}
if ($response->serverError() || $response->clientError()) {

$responseArray = $response->json();

if (isset($responseArray['detail']) && !empty($responseArray['detail'])) {
$message = $responseArray['detail'];
} else if (isset($responseArray['scimType']) && !empty($responseArray['scimType'])) {
$message = $responseArray['scimType'];
} else {
if (isset($responseArray['schemas']) && is_array($responseArray['schemas'])) {
$message = implode(", ", $responseArray['schemas']);
} else if (isset($responseArray['schemas']) && !is_array($responseArray['schemas'])) {
$message = $responseArray['schemas'];
}
}
$this->logInfo($message, [
'body' => $response->body(),
'collect' => $response->collect(),
'status_code' => $response->status(),
'is_response_200' => $response->ok(),
'is_successful' => $response->successful(),
'is_failed' => $response->failed(),
'is_serverError' => $response->serverError(),
'is_clientErro' => $response->clientError(),
'headers' => $response->headers(),
]);
}

if(!empty($customMessage)){
$message = $customMessage;
}
if (!empty($customMessage)) {
$message = $customMessage;
}

if(empty($data) && !empty($response->json())){
$responseData = $response->json();
} else if(!empty($data) && !empty($response->json())){
$responseData = array_merge($data, $response->json());
}
if (empty($data) && !empty($response->json())) {
$responseData = $response->json();
} else if (!empty($data) && !empty($response->json())) {
$responseData = array_merge($data, $response->json());
}

return [
'status' => $response->successful(),
'code' => $response->status(),
'message' => $message,
'data' => $responseData
];
return [
'status' => $response->successful(),
'code' => $response->status(),
'message' => $message,
'data' => $responseData
];
}

public function logInfo($message, $array = []){
if($this->isEnabledDebug())
Log::debug("IDP Log:: ".$message, (array) $array);
public function logInfo($message, $array = [])
{
if ($this->isEnabledDebug())
Log::debug("IDP Log:: " . $message, (array)$array);
}

public function prepareUserInfoToBeCreated($userinfo)
Expand All @@ -163,17 +177,19 @@ public function prepareUserInfoToBeCreated($userinfo)
$country = $userinfo['country'] ?? 'Bangladesh';
$password = $userinfo['password'] ?? '12345678';
$birthDate = $userinfo['birthdate'] ?? null;
$divisionBbsCode = $userinfo['division_bbs_code'] ?? null;
$districtBbsCode = $userinfo['district_bbs_code'] ?? null;
$isAccountDisabled = isset($userinfo['account_disable']) ? ($userinfo['account_disable'] == 1 ? true : false) : null;
$isAccountLocked = isset($userinfo['account_lock']) ? ($userinfo['account_lock'] == 1 ? true : false) : null;


if(empty($first_name) || empty($last_name) || empty($username) || empty($email) || empty($mobile) || empty($user_type) || empty($active)){
$this->logInfo("missing necessary user property. Provided user Info - ", (array) $userinfo);
if (empty($first_name) || empty($last_name) || empty($username) || empty($email) || empty($mobile) || empty($user_type) || empty($active)) {
$this->logInfo("missing necessary user property. Provided user Info - ", (array)$userinfo);
throw new \Exception("missing necessary user property", 422);
}

if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
$this->logInfo("Invalid provided email. Provided user Info - ", (array) $userinfo);
$this->logInfo("Invalid provided email. Provided user Info - ", (array)$userinfo);
throw new \Exception("Invalid provided email", 422);
}
$payload = [
Expand All @@ -195,12 +211,14 @@ public function prepareUserInfoToBeCreated($userinfo)
'accountLocked' => $isAccountLocked,
'department' => $department,
'country' => $country,
'organization' => $organization
'organization' => $organization,
'division' => $divisionBbsCode,
'region' => $districtBbsCode,
],
'emails' => [
0 => $email
],
'phoneNumbers' => [
'phoneNumbers' => [
[
"value" => $mobile,
'type' => 'mobile',
Expand All @@ -209,7 +227,7 @@ public function prepareUserInfoToBeCreated($userinfo)
]
];

if(!empty($birthDate)){
if (!empty($birthDate)) {
$payload['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['dateOfBirth'] = $birthDate;
}

Expand All @@ -223,8 +241,8 @@ public function preparePasswordResetSchema($userCrediantialInfo)
$newPassword = $userCrediantialInfo['new_password'] ?? null;


if(empty($currentPassword) || empty($username) || empty($newPassword)){
$this->logInfo("missing necessary user crediantial. Provided user crediantial - ", (array) $userCrediantialInfo);
if (empty($currentPassword) || empty($username) || empty($newPassword)) {
$this->logInfo("missing necessary user crediantial. Provided user crediantial - ", (array)$userCrediantialInfo);
throw new \Exception("username or password or new password missing", 422);
}

Expand Down Expand Up @@ -264,17 +282,17 @@ public function prepareUserInfoToBeUpdated($userinfo)
$isAccountLocked = isset($userinfo['account_lock']) ? ($userinfo['account_lock'] == 1 ? true : false) : null;
$birthDate = $userinfo['birthdate'] ?? null;

if(empty($ID)){
$this->logInfo("missing user ID. Provided user Info - ", (array) $userinfo);
if (empty($ID)) {
$this->logInfo("missing user ID. Provided user Info - ", (array)$userinfo);
throw new \Exception("ID is mendatory.", 422);
}
if(empty($username)){
$this->logInfo("missing username. Provided user Info - ", (array) $userinfo);
if (empty($username)) {
$this->logInfo("missing username. Provided user Info - ", (array)$userinfo);
throw new \Exception("username is mendatory.", 422);
}

if (!empty($email) && !filter_var($email, FILTER_VALIDATE_EMAIL)) {
$this->logInfo("Invalid provided email. Provided user Info - ", (array) $userinfo);
$this->logInfo("Invalid provided email. Provided user Info - ", (array)$userinfo);
throw new \Exception("Invalid provided email", 422);
}

Expand All @@ -286,62 +304,62 @@ public function prepareUserInfoToBeUpdated($userinfo)
];
$values = [];

if(!empty($first_name)){
if (!empty($first_name)) {
$values['name']['givenName'] = $first_name;
}

if(!empty($last_name)){
if (!empty($last_name)) {
$values['name']['familyName'] = $last_name;
}

if($isAccountDisabled !== null){
if ($isAccountDisabled !== null) {
# more about account state https://is.docs.wso2.com/en/latest/learn/pending-account-status/
# also another way to set payload curl -v -k --user admin:admin -X PATCH -d '{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:accountLocked", "value": true}]}' --header "Content-Type:application/json" https://identity.com/scim2/Users/id
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['accountDisabled'] = $isAccountDisabled;
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['accountDisabled'] = $isAccountDisabled;
}
if($isAccountLocked !== null){
if ($isAccountLocked !== null) {
# more about account state https://is.docs.wso2.com/en/latest/learn/pending-account-status/
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['accountLocked'] = $isAccountLocked;
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['accountLocked'] = $isAccountLocked;
}
if(!empty($organization)){
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['organization'] = $organization;
if (!empty($organization)) {
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['organization'] = $organization;
}
if(!empty($department)){
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['department'] = $department;
if (!empty($department)) {
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['department'] = $department;
}
if(!empty($country)){
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['country']= $country;
if (!empty($country)) {
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['country'] = $country;
}
if(!empty($birthDate)){
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['dateOfBirth']= $birthDate;
if (!empty($birthDate)) {
$values['urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']['dateOfBirth'] = $birthDate;
}
if(!empty($password)){
$values['password'] = $password;
if (!empty($password)) {
$values['password'] = $password;
}

if(!empty($user_type)){
if (!empty($user_type)) {
$values['userType'] = $user_type;
}

if(!empty($active)){
$values['active'] = (string) $active;
if (!empty($active)) {
$values['active'] = (string)$active;
}

if(!empty($email)){
$values['emails'] = [
if (!empty($email)) {
$values['emails'] = [
0 => $email
];
}
if(!empty($mobile)){
$values['phoneNumbers'] = [
[
"value" => $mobile,
'type' => 'mobile',
if (!empty($mobile)) {
$values['phoneNumbers'] = [
[
"value" => $mobile,
'type' => 'mobile',
"primary" => "false"
]
]
];
}
if(empty($values)){
if (empty($values)) {
$this->logInfo("Update value can not be empty, please add something to update");
throw new \Exception("Empty value provided, Nothing to update.", 422);
}
Expand Down

0 comments on commit e06110a

Please sign in to comment.