--- title: ユーザー招待を取得 description: UUID によって単一のユーザー招待を返します。 breadcrumbs: ドキュメント > API > ユーザー招待を取得 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # ユーザー招待を取得 ## v2 (latest) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/user_invitations/{user_invitation_uuid} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/user_invitations/{user_invitation_uuid} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/user_invitations/{user_invitation_uuid} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/user_invitations/{user_invitation_uuid} | ### Overview UUID によって単一のユーザー招待を返します。 This endpoint requires the `user_access_invite` permission. OAuth apps require the `user_access_invite` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ja/api/latest/scopes.md#users) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | --------------------------------- | ------ | -------------------------------- | | user_invitation_uuid [*required*] | string | The UUID of the user invitation. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} User invitation as returned by the API. | Parent field | Field | Type | Description | | ------------- | ----------------- | --------- | -------------------------------------------------------------------------------------------- | | | data | object | Object of a user invitation returned by the API. | | data | attributes | object | Attributes of a user invitation. | | attributes | created_at | date-time | Creation time of the user invitation. | | attributes | expires_at | date-time | Time of invitation expiration. | | attributes | invite_type | string | Type of invitation. | | attributes | uuid | string | UUID of the user invitation. | | data | id | string | ID of the user invitation. | | data | relationships | object | Relationships data for user invitation. | | relationships | user [*required*] | object | Relationship to user. | | user | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | data | type | enum | User invitations type. Allowed enum values: `user_invitations`. Default: `user_invitations`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "expires_at": "2019-09-19T10:00:00.000Z", "invite_type": "string", "uuid": "string" }, "id": "string", "relationships": { "user": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } } }, "type": "user_invitations" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Authentication error {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export user_invitation_uuid="00000000-0000-0000-3456-000000000000" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/user_invitations/${user_invitation_uuid}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get a user invitation returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // the "user" has a "user_invitation" UserInvitationID := os.Getenv("USER_INVITATION_ID") ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewUsersApi(apiClient) resp, r, err := api.GetInvitation(ctx, UserInvitationID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GetInvitation`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `UsersApi.GetInvitation`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get a user invitation returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.UsersApi; import com.datadog.api.client.v2.model.UserInvitationResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); UsersApi apiInstance = new UsersApi(defaultClient); // the "user" has a "user_invitation" String USER_INVITATION_ID = System.getenv("USER_INVITATION_ID"); try { UserInvitationResponse result = apiInstance.getInvitation(USER_INVITATION_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling UsersApi#getInvitation"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get a user invitation returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.users_api import UsersApi # the "user" has a "user_invitation" USER_INVITATION_ID = environ["USER_INVITATION_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = UsersApi(api_client) response = api_instance.get_invitation( user_invitation_uuid=USER_INVITATION_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get a user invitation returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::UsersAPI.new # the "user" has a "user_invitation" USER_INVITATION_ID = ENV["USER_INVITATION_ID"] p api_instance.get_invitation(USER_INVITATION_ID) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get a user invitation returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_users::UsersAPI; #[tokio::main] async fn main() { // the "user" has a "user_invitation" let user_invitation_id = std::env::var("USER_INVITATION_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = UsersAPI::with_config(configuration); let resp = api.get_invitation(user_invitation_id.clone()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get a user invitation returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.UsersApi(configuration); // the "user" has a "user_invitation" const USER_INVITATION_ID = process.env.USER_INVITATION_ID as string; const params: v2.UsersApiGetInvitationRequest = { userInvitationUuid: USER_INVITATION_ID, }; apiInstance .getInvitation(params) .then((data: v2.UserInvitationResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}