User Management
Marketo提供了一组用户管理端点，允许您对Marketo中的用户记录执行CRUD操作。 创建用户的方法是向用户发送邀请，随后用户设置密码并首次获得对Marketo的访问权限。
与其他Marketo REST API不同，在使用用户管理API时：
-
您必须使用HTTP标头方法发送访问令牌以进行身份验证。 您不能将访问令牌作为查询字符串参数传递。 有关身份验证的更多信息，请此处。
-
创建REST API的自定义服务的用户角色时，必须从两个不同的组中选择一个角色权限：
- 来自访问管理员组的“访问用户”权限
- 从Access API组访问“Access User Management Api”
-
响应正文不包含指示调用成功或失败的“success”布尔属性。 相反，您必须评估HTTP响应状态代码。 如果调用成功，则返回200状态代码。 如果调用失败，将返回非200级的状态代码，并且响应正文包含标准“错误”数组，其中含有错误代码和描述性错误消息。
-
日期时间字符串的格式为
yyyyMMdd'T'HH:mm:ss.SSS't'+|-hhmm。 这适用于以下属性：createdAt、updatedAt、expiresAt。 -
用户管理API端点未像其他端点一样带有“/rest”前缀。
查询
对用户管理的查询支持包括检索所有用户、角色和工作区的功能。 此外，您还可以按用户ID检索单个用户记录，或按用户ID检索角色/工作区记录。
用户（按ID）
通过ID获取用户终结点采用单个userid路径参数，并为已接受其邀请的用户返回单个用户记录。
GET /userservice/management/v1/users/{userid}/user.json
{
"userid": "jamie@houselannister.com",
"firstName": "Jamie",
"lastName": "Lannister",
"emailAddress": "jamie@lannister.com",
"optedIn": false,
"failedLogins": 0,
"failedDeviceCode": 0,
"isLocked": false,
"lockedReason": null,
"id": 0,
"apiOnly": false,
"userRoleWorkspaces": [
{
"accessRoleId": 1,
"accessRoleName": "Admin",
"workspaceId": 0,
"workspaceName": "AllZones"
},
{
"accessRoleId": 2,
"accessRoleName":
"Standard User",
"workspaceId": 1008,
"workspaceName": "World"
}
],
"expiresAt": "2020-12-31T08:00:00.000t+0000",
"lastLoginAt": "2020-02-05T01:02:23.000t+0000"
}
按ID列出的邀请用户
按ID获取受邀用户端点采用单个userid路径参数并返回“待处理”用户的单个用户记录（尚未接受其邀请）。
GET /userservice/management/v1/users/{userid}/invite.json
{
"id": 25112,
"firstName": "Jamie",
"lastName": "Lannister",
"emailAddress": "jamie@lannister.com",
"userId": "jamie@lannister.com",
"subscriptionId": 3381,
"status": "pending",
"expiresAt": "20200807T20:49:54.0t+0000",
"createdAt": "20200731T20:49:54.0t+0000",
"updatedAt": "20200731T20:49:54.0t+0000"
}
按Id划分的角色和工作区
按ID获取角色和工作区端点采用单个userid路径参数并返回用户角色和工作区记录的列表。 响应包含一个数组，该数组包含一个对象，该对象包含指定用户的角色和工作区ID和名称。
GET /userservice/management/v1/users/{userid}/roles.json
[
{
"accessRoleId": 1,
"accessRoleName": "Admin",
"workspaceId": 0,
"workspaceName": "AllZones"
},
{
"accessRoleId": 2,
"accessRoleName": "Standard User",
"workspaceId": 1008,
"workspaceName": "World"
}
]
浏览用户
获取用户终结点返回所有用户记录的列表。 可选的pageSize参数是一个整数，它指定要返回的最大条目数。 默认值为20。 最大值为200。 可选的pageOffset参数是一个整数，它指定从何处开始检索条目。 可与pageSize一起使用。 默认值为0。
GET /userservice/management/v1/users/allusers.json
[
{
"userid": "jamie@lannister.com",
"firstName": "Jamie",
"lastName": "Lannister",
"emailAddress": "jamie@houselannister.com",
"id": 6785,
"apiOnly": false
},
{
"userid": "jeoffery@housebaratheon.com",
"firstName": "Jeoffery",
"lastName": "Baratheon",
"emailAddress": "jeoffery@housebaratheon.com",
"id": 7718,
"apiOnly": false
},
{
"userid": "rickon@housestark.com",
"firstName": "Rickon",
"lastName": "Stark",
"emailAddress": "rickon@housestark.com",
"id": 8612,
"apiOnly": false
}
]
userid适用于已迁移到Adobe IMS的客户。 尚未迁移的客户将在userid字段中看到常规电子邮件地址。浏览角色
获取角色终结点返回所有角色记录的列表。
GET /userservice/management/v1/users/roles.json
[
{
"id": 1,
"name": "Admin",
"description": "All permissions",
"type": "system",
"hidden": false,
"onlyAllZones": true,
"createdAt": "20100327T18:27:42.0t+0000",
"updatedAt": "20100327T18:27:42.0t+0000"
},
{
"id": 2,
"name": "Standard User",
"description": "All permissions except Admin",
"type": "system",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20100327T18:27:42.0t+0000",
"updatedAt": "20180423T02:33:29.0t+0000"
},
{
"id": 24,
"name": "RTP Launcher",
"description": "Role required for launcher in RTP",
"type": "system",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20151024T01:45:40.0t+0000",
"updatedAt": "20171024T23:41:24.0t+0000"
},
{
"id": 25,
"name": "RTP Editor",
"description": "Role required for editor in RTP",
"type": "system",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20151024T01:45:40.0t+0000",
"updatedAt": "20171024T23:41:24.0t+0000"
},
{
"id": 101,
"name": "Analytics User",
"description": "Has access to Analytics",
"type": "custom",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20100327T18:27:42.0t+0000",
"updatedAt": "20180423T02:33:29.0t+0000"
},
{
"id": 102,
"name": "Marketing User",
"description": "All permissions except Admin",
"type": "custom",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20100327T18:27:42.0t+0000",
"updatedAt": "20100327T18:27:42.0t+0000"
},
{
"id": 103,
"name": "Web Designer",
"description": "Has access to Design Studio except approval permission",
"type": "custom",
"hidden": false,
"onlyAllZones": false,
"createdAt": "20100327T18:27:42.0t+0000",
"updatedAt": "20180423T02:33:29.0t+0000"
}
]
浏览工作区
获取工作区终结点返回所有工作区记录的列表。
GET /userservice/management/v1/users/workspaces.json
[
{
"id": 1,
"name": "Default",
"description": "Initial workspace for Marketing Activities, Design Studio, and so on.",
"globalViz": 0,
"status": "active",
"currencyInfo": null,
"createdAt": "20160910T23:08:05.0t+0000",
"updatedAt": "20160910T23:08:05.0t+0000"
},
{
"id": 1008,
"name": "World",
"description": "",
"globalViz": 0,
"status": "active",
"currencyInfo": null,
"createdAt": "20181119T21:59:36.0t+0000",
"updatedAt": "20181119T21:59:36.0t+0000"
},
{
"id": 1009,
"name": "Reproduction - US English - All Leads",
"description": "A Workspace for recreating customer-reported problems.",
"globalViz": 1,
"status": "active",
"currencyInfo": null,
"createdAt": "20190129T23:36:37.0t+0000",
"updatedAt": "20190129T23:36:37.0t+0000"
},
{
"id": 1010,
"name": "US",
"description": "United States - Qualified Leads",
"globalViz": 0,
"status": "active",
"currencyInfo": null,
"createdAt": "20190322T15:55:40.0t+0000",
"updatedAt": "20190322T15:55:40.0t+0000"
}
]
邀请用户
在Adobe IMS集成订阅上，此终结点仅支持仅API用户的邀请。 要邀请标准用户，请改用Adobe用户管理API。
邀请用户端点向新用户发送“欢迎使用Marketo”电子邮件邀请。 电子邮件正文包含“登录到Marketo”链接，该链接允许用户首次访问Marketo。 要接受邀请，电子邮件收件人请单击“登录到Marketo”链接，创建其密码，然后获得对Marketo的访问权限。 在接受过程完成之前，邀请处于“待处理”状态，可能无法编辑用户记录。 待处理的邀请将在发送七天后过期。 有关管理用户的详细信息可在此处找到。
参数以application/json格式在请求正文中传递。
需要以下参数： emailAddress，firstName，lastName, userRoleWorkspaces。 userRoleWorkspaces参数是包含accessRoleId和workspaceId属性的对象数组。
userid参数是用于用户登录的唯一用户标识符字符串值，必须格式化为电子邮件地址。 如果未在请求中提供，则userid的值默认为emailAddress参数中提供的值。
布尔apiOnly参数指定用户是否为仅限API的用户。 expiresAt参数指定用户登录过期时间，并使用W3C ISO-8601格式（不含毫秒）进行格式化。 如果未在请求中提供，则用户永不过期。 reason参数是一个描述用户邀请原因的字符串。
如果成功，端点将返回值“true”，否则返回错误消息。
POST /userservice/management/v1/users/invite.json
Content-Type: application/json
{
"emailAddress": "daenerys@housetargaryen.com",
"firstName": "Daenerys",
"lastName": "Targaryen",
"expiresAt": "2020-12-31T23:59:59-05:00",
"reason": "Keeper of dragons",
"userRoleWorkspaces": [
{
"accessRoleId": 1,
"workspaceId": 0
}
]
}
true
以下是发送给新用户的“欢迎使用Marketo”电子邮件邀请示例。 电子邮件主题行是“Marketo登录信息”，发件人是与REST API自定义服务关联的仅API用户的电子邮件地址，收件人是通过firstName、lastName和emailAddress参数指定的。
用户通过输入两次密码并单击“创建密码”按钮来接受电子邮件邀请。 然后，她首次被授予访问Marketo的权限。
更新用户
更新对用户支持的功能包括更新用户属性或删除用户。 只能更新已接受其邀请的用户。 属性以application/json格式作为参数在请求主体中传递。
更新用户属性
在Adobe IMS集成订阅上，此终结点仅支持更新仅限API的用户的属性。 要更新标准用户的属性，请改用Adobe用户管理API。
更新用户属性终结点采用单个userid路径参数并返回单个用户记录。 请求正文包含一个或多个要更新的用户属性： emailAddress、firstName、lastName、expiresAt。
POST /userservice/management/v1/users/{userid}/update.json
Content-Type: application/json
{
"firstName": "JAMIE",
"lastName": "LANISTER",
"expiresAt": "20211231T08:00:00.000t+0000"
}
{
"userid": "jamie@houselannister.com",
"firstName": "JAMIE",
"lastName": "LANISTER",
"emailAddress": "jamie@houselannister.com",
"optedIn": false,
"failedLogins": 0,
"failedDeviceCode": 0,
"isLocked": false,
"lockedReason": null,
"id": 0,
"apiOnly": false,
"userRoleWorkspaces": [
{
"accessRoleId": 1,
"accessRoleName": "Admin",
"workspaceId": 0,
"workspaceName": "AllZones"
},
{
"accessRoleId": 2,
"accessRoleName":
"Standard User",
"workspaceId": 1008,
"workspaceName": "World"
}
],
"expiresAt": "2021-12-31T08:00:00.000t+0000"
"lastLoginAt": "2020-02-05T01:02:23.000t+0000"
}
删除用户
在Adobe IMS集成订阅上，此端点仅支持删除仅限API的用户。 要删除标准用户，请改用Adobe用户管理API。
删除用户终结点采用单个userid路径参数并从实例中删除相应的用户。 这是破坏性删除，无法撤消。 如果成功，则返回200状态代码，否则返回错误消息。
POST /userservice/management/v1/users/{userid}/delete.json
删除受邀用户
删除受邀用户终结点采用单个userid路径参数并从实例中删除相应的“挂起”用户（用户尚未接受其邀请）。 这是破坏性删除，无法撤消。 如果成功，则返回200状态代码，否则返回错误消息。
POST /userservice/management/v1/users/{userid}/invite/delete.json
更新角色
更新对角色的支持包括添加和删除角色的功能。 属性以application/json格式作为参数在请求主体中传递。
添加角色
添加角色终结点采用单个userid路径参数，并将一个或多个用户角色添加到相应的用户。 请求正文包含一个或多个对象的列表，每个对象都包含 accessRoleId和workspaceId属性。 如果成功，则返回指定用户的accessRoleId/workspaceId对的完整列表。
POST /userservice/management/v1/users/{userid}/roles/create.json
Content-Type: application/json
[
{
"accessRoleId": 2,
"workspaceId": 1008
}
]
[
{
"accessRoleId": 1,
"accessRoleName": "Admin",
"workspaceId": 0,
"workspaceName": "AllZones"
},
{
"accessRoleId": 2,
"accessRoleName": "Standard User",
"workspaceId": 1008,
"workspaceName": "World"
}
]
删除角色
删除角色终结点采用单个userid路径参数，并从相应的用户中删除一个或多个用户角色。 请求正文包含一个或多个对象的列表，每个对象都包含 accessRoleId和workspaceId属性。 如果成功，则会返回指定用户的accessRoleId/workspaceId对的剩余列表。
POST /userservice/management/v1/users/{userid}/roles/delete.json
Content-Type: application/json
[
{
"accessRoleId": 2,
"workspaceId": 1008
}
]
[
{
"accessRoleId": 1,
"accessRoleName": "Admin",
"workspaceId": 0,
"workspaceName": "AllZones"
}
]