299 lines
12 KiB
JSON
299 lines
12 KiB
JSON
{
|
|
"name": "UpdateUserTeamMembership",
|
|
"fully_qualified_name": "DatadogApi.UpdateUserTeamMembership@0.1.0",
|
|
"description": "Update a user's membership attributes on a team.\n\nUse this tool to update specific membership attributes for a user within a team's membership in Datadog. This can be useful when user roles or permissions need modification.",
|
|
"toolkit": {
|
|
"name": "ArcadeDatadogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "team_id",
|
|
"required": true,
|
|
"description": "The unique identifier of the team to update the user's membership attributes.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "None"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "team_id"
|
|
},
|
|
{
|
|
"name": "user_identifier",
|
|
"required": true,
|
|
"description": "The unique identifier for the user whose membership is being updated. This is required to specify which user's attributes will be changed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "None"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "user_id"
|
|
},
|
|
{
|
|
"name": "team_membership_type",
|
|
"required": true,
|
|
"description": "Specify the type of team membership. The value must be 'team_memberships'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"team_memberships"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Team membership type"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.type"
|
|
},
|
|
{
|
|
"name": "provisioning_mechanism",
|
|
"required": false,
|
|
"description": "Specifies how the team relationship was provisioned. Options: null, \"service_account\", \"saml_mapping\".",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, \"service_account\" if added by a service account, and \"saml_mapping\" if provisioned via SAML mapping."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.provisioned_by"
|
|
},
|
|
{
|
|
"name": "provisioning_identifier",
|
|
"required": false,
|
|
"description": "UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.provisioned_by_id"
|
|
},
|
|
{
|
|
"name": "user_role_in_team",
|
|
"required": false,
|
|
"description": "Specify the user's role within the team. Accepts 'admin'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"admin"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The user's role within the team"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.role"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'UpdateTeamMembership'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "DATADOG_API_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_APPLICATION_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_BASE_URL"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Datadog API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://{datadog_base_url}/api/v2/team/{team_id}/memberships/{user_id}",
|
|
"http_method": "PATCH",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "team_id",
|
|
"tool_parameter_name": "team_id",
|
|
"description": "None",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "None"
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"tool_parameter_name": "user_identifier",
|
|
"description": "None",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "None"
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.provisioned_by",
|
|
"tool_parameter_name": "provisioning_mechanism",
|
|
"description": "The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, \"service_account\" if added by a service account, and \"saml_mapping\" if provisioned via SAML mapping.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, \"service_account\" if added by a service account, and \"saml_mapping\" if provisioned via SAML mapping."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.provisioned_by_id",
|
|
"tool_parameter_name": "provisioning_identifier",
|
|
"description": "UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.role",
|
|
"tool_parameter_name": "user_role_in_team",
|
|
"description": "The user's role within the team",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"admin"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The user's role within the team"
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.type",
|
|
"tool_parameter_name": "team_membership_type",
|
|
"description": "Team membership type",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"team_memberships"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Team membership type"
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": "team_memberships",
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "DATADOG_API_KEY",
|
|
"parameter_name": "DD-API-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_APPLICATION_KEY",
|
|
"parameter_name": "DD-APPLICATION-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_BASE_URL",
|
|
"parameter_name": "datadog_base_url",
|
|
"accepted_as": "path",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"description\": \"Team membership request\",\n \"properties\": {\n \"data\": {\n \"description\": \"A user's relationship with a team\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"Team membership attributes\",\n \"properties\": {\n \"provisioned_by\": {\n \"description\": \"The mechanism responsible for provisioning the team relationship.\\nPossible values: null for added by a user, \\\"service_account\\\" if added by a service account, and \\\"saml_mapping\\\" if provisioned via SAML mapping.\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"provisioned_by_id\": {\n \"description\": \"UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"role\": {\n \"description\": \"The user's role within the team\",\n \"enum\": [\n \"admin\"\n ],\n \"nullable\": true,\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"ADMIN\"\n ]\n }\n },\n \"type\": \"object\"\n },\n \"type\": {\n \"default\": \"team_memberships\",\n \"description\": \"Team membership type\",\n \"enum\": [\n \"team_memberships\"\n ],\n \"example\": \"team_memberships\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"TEAM_MEMBERSHIPS\"\n ]\n }\n },\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|