เกตเวย์ API คอนเวอร์ชั่นสำหรับ Control Plane API แบบหลายบัญชี: เอกสารอ้างอิง

การจัดการผู้ใช้

เพิ่มผู้ใช้พร้อมด้วยบทบาท

เพิ่มผู้ใช้ใหม่สำหรับอีเมลที่ระบุและชื่อบทบาท

สกีมา

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
mutation useAddUserAccountMutation(
  $addUserWithRoleInput: AddUserWithRoleInput!
) {
  userMutations {
    addUserWithRole(input: $addUserWithRoleInput) {
      userAlreadyExist
      invitationLink
      user {
        id
        email
        status
        roles {
          name
          displayName
        }
        isSelf
        canBeDeleted
        defaultTenantId
      }
    }
  }
}
_________________________________________________________________________________________________________    
input AddUserWithRoleInput {
    email: String!
    roleName: String!
}
     

ช่อง

AddUserWithRoleInput

การส่งคืน

AddUserResponse

รหัสข้อผิดพลาด

ตัวอย่างคำขอ

การเปลี่ยนแปลง

mutation useAddUserAccountMutation(
 $addUserWithRoleInput: AddUserWithRoleInput!
) {
 userMutations {
   addUserWithRole(input: $addUserWithRoleInput) {
     userAlreadyExist
     invitationLink
     user {
       id
       email
       status
       roles {
         name
         displayName
       }
     }
   }
 }
}
     

ตัวแปร

{
   "addUserWithRoleInput": {
           "email": "tempUser1@testaccount.com",
           "roleName": "advertiser-manage-wW58k7FQ"
       }
}
     

ตัวอย่างการตอบกลับ

{
   "data": {
       "userMutations": {
           "addUserWithRole": {
               "userAlreadyExist": false,
               "invitationLink": "http://localhost:8443/auth/verify/?token=0MGaMI_FRDe80OAgrSSdZw&et=inv&email=tempUser1@testaccount.com",
               "user": {
                   "id": "97a9753d-a469-4f23-8aa7-748e4cf86877",
                   "email": "tempuser1@testaccount.com",
                   "status": 2,
                   "roles": [
                       {
                           "name": "advertiser-manage-wW58k7FQ",
                           "displayName": "manage"
                       }
                   ]
               }
           }
       }
   }
}

เปลี่ยนบทบาทของผู้ใช้

อนุญาตให้เพิ่มหรือเพิกถอนบทบาทของผู้ใช้

สกีมา

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
mutation UserAccessChangeMutation(
  $changeRoleForUserInput: ChangeRoleForUserInput!
) {
  userMutations {
    changeRoleForUser(input: $changeRoleForUserInput) {
      user {
        id
        email
        status
        roles {
          name
          displayName
        }
        isSelf
        canBeDeleted
        defaultTenantId
      }
    }
  }
}
_________________________________________________________________________________________________________    
input ChangeRoleForUserInput {
    userId: String!
    roleToRevoke: String
    roleToAdd: String
}
     

ช่อง

ChangeRoleForUserInput

การส่งคืน

ChangeRoleForUserResponse

รหัสข้อผิดพลาด

ตัวอย่างคำขอ

การเปลี่ยนแปลง

mutation UserAccessChangeMutation(
 $changeRoleForUserInput: ChangeRoleForUserInput!
) {
 userMutations {
   changeRoleForUser(input: $changeRoleForUserInput) {
     user {
       id
       email
       roles {
         name
         displayName
       }
     }
   }
 }
}
     

ตัวแปร

{
   "changeRoleForUserInput": {
           "userId": "97a9753d-a469-4f23-8aa7-748e4cf86877",
           "roleToRevoke": "advertiser-admin-wW58k7FQ",
           "roleToAdd": "agency-admin"
       }
}
     

ตัวอย่างการตอบกลับ

{
   "data": {
       "userMutations": {
           "changeRoleForUser": {
               "user": {
                   "id": "97a9753d-a469-4f23-8aa7-748e4cf86877",
                   "email": "tempuser1@testaccount.com",
                   "roles": [
                       {
                           "name": "agency-admin",
                           "displayName": "admin"
                       }
                   ]
               }
           }
       }
   }
}
     

สร้างและส่งคำเชิญ

สร้างลิงก์คำเชิญสำหรับผู้ใช้ใหม่ และหากเปิดใช้งานฟีเจอร์ SMTP ระบบจะส่งอีเมลไปยังอีเมลที่ระบุ แต่หากไม่ได้เปิดใช้งาน ระบบจะส่งคืนเอาต์พุตเท่านั้น

สกีมา

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
mutation ActivateElementMutation(
  $sendInvitationInput: SendInvitationInput!
) {
  userMutations {
    sendInvitation(input: $sendInvitationInput)
  }
}
_________________________________________________________________________________________________________    
input SendInvitationInput {
    email: String!
    tenantId: String
    userType: UserType!
}
     

ช่อง

SendInvitationInput

การส่งคืน

รหัสข้อผิดพลาด

ตัวอย่างคำขอ

การเปลี่ยนแปลง

mutation ActivateElementMutation(
 $sendInvitationInput: SendInvitationInput!
) {
 userMutations {
   sendInvitation(input: $sendInvitationInput)
 }
}
     

ตัวแปร

{
   "sendInvitationInput": {
           "email": "tempuser1@testaccount.com",
           "tenantId": "wW58k7FQ",
           "userType": "ADVERTISER"
   }
      
}
     

ตัวอย่างการตอบกลับ

"data": {
       "userMutations": {
           "sendInvitation": "http://localhost:8443/auth/verify/?token=uo3hMrl1QEeUtx5PXRoUvg&et=inv&email=tempuser1@testaccount.com"
       }
   }

ดูเพิ่มเติม

• เกตเวย์ API คอนเวอร์ชั่นสำหรับ Control Plane API แบบหลายบัญชี
• Control Plane API: เอกสารอ้างอิง
• เอกสารอ้างอิง Control Plane API: การจัดการบัญชี
• เอกสารอ้างอิง Control Plane API: การจัดการพิกเซล
• เอกสารอ้างอิง Control Plane API: การกำหนดค่าการกำหนดเส้นทางข้อมูลบัญชี
• เอกสารอ้างอิง Control Plane API: เกณฑ์ชี้วัดเหตุการณ์ในบัญชี
• เอกสารอ้างอิง Control Plane API: อ็อบเจ็กต์