EnterpriseLdapUserSync() public static method

public static EnterpriseLdapUserSync ( string userName ) : Uri
userName string
return System.Uri
ApiUrls Class Documentation
Example #1
0
        /// <summary>
        /// Queue an LDAP Sync job for a user on a GitHub Enterprise appliance (must be Site Admin user).
        /// </summary>
        /// <remarks>
        /// https://developer.github.com/v3/enterprise/ldap/#sync-ldap-mapping-for-a-user
        /// </remarks>
        /// <param name="userName">The userName to sync LDAP mapping</param>
        /// <returns>The <see cref="LdapSyncResponse"/> of the queue request.</returns>
        public async Task <LdapSyncResponse> QueueSyncUserMapping(string userName)
        {
            Ensure.ArgumentNotNull(userName, "userName");

            var endpoint = ApiUrls.EnterpriseLdapUserSync(userName);

            var response = await Connection.Post <LdapSyncResponse>(endpoint).ConfigureAwait(false);

            if (response.HttpResponse.StatusCode != HttpStatusCode.Created)
            {
                throw new ApiException("Invalid Status Code returned. Expected a 201", response.HttpResponse.StatusCode);
            }

            return(response.Body);
        }