[8.2] Add the User Profiles APIs

Co-authored-by: Seth Michael Larson <[email protected]>

Author: github-actions[bot]

output/schema/schema.json

@@ -0,0 +1,23 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export enum GrantType {
+  password,
+  access_token
+}

output/schema/validation-errors.json

@@ -0,0 +1,42 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Dictionary } from '@spec_utils/Dictionary'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import { User } from './User'
+import { long } from '@_types/Numeric'
+import { SequenceNumber } from '@_types/common'
+
+export class UserProfileHitMetadata {
+  _primary_term: long
+  _seq_no: SequenceNumber
+}
+
+export class UserProfile {
+  uid: string
+  user: User
+  data?: Dictionary<string, UserDefinedValue>
+  access?: Dictionary<string, UserDefinedValue>
+  enabled?: boolean
+}
+
+export class UserProfileWithMetadata extends UserProfile {
+  last_synchronized: long
+  _doc?: UserProfileHitMetadata
+}

output/typescript/types.ts

@@ -0,0 +1,36 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { GrantType } from '@security/_types/GrantType'
+
+/**
+ * Creates or updates a user profile on behalf of another user.
+ * @rest_spec_name security.activate_user_profile
+ * @since 8.2.0
+ * @stability experimental
+ */
+export interface Request extends RequestBase {
+  body: {
+    access_token?: string
+    grant_type: GrantType
+    password?: string
+    username?: string
+  }
+}

specification/security/_types/GrantType.ts

@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { UserProfileWithMetadata } from '@security/_types/UserProfile'
+
+export class Response {
+  body: UserProfileWithMetadata
+}

specification/security/_types/UserProfile.ts

@@ -0,0 +1,45 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Refresh } from '@_types/common'
+
+/**
+ * Disables a user profile so it's not visible in user profile searches.
+ * @rest_spec_name security.disable_user_profile
+ * @since 8.2.0
+ * @stability experimental
+ */
+export interface Request extends RequestBase {
+  path_parts: {
+    /**
+     * Unique identifier for the user profile.
+     */
+    uid: string
+  }
+  query_parameters: {
+    /**
+     * If 'true', Elasticsearch refreshes the affected shards to make this operation
+     * visible to search, if 'wait_for' then wait for a refresh to make this operation
+     * visible to search, if 'false' do nothing with refreshes.
+     * @server_default false
+     */
+    refresh?: Refresh
+  }
+}